1 # -*- coding: utf-8 -*-
9 def escape_ly_output_string (input_string):
10 return_string = input_string
11 needs_quotes = not re.match (u"^[a-zA-ZäöüÜÄÖßñ]*$", return_string);
13 return_string = "\"" + string.replace (return_string, "\"", "\\\"") + "\""
22 self._name = 'xml_node'
24 self._attribute_dict = {}
26 def get_parent (self):
30 return self._parent.get_typed_children (self.__class__)[0] == self
41 if not self._children:
44 return ''.join ([c.get_text () for c in self._children])
46 def message (self, msg):
47 sys.stderr.write (msg+'\n')
51 sys.stderr.write (' In: <%s %s>\n' % (p._name, ' '.join (['%s=%s' % item for item in p._attribute_dict.items()])))
54 def get_typed_children (self, klass):
58 return [c for c in self._children if isinstance(c, klass)]
60 def get_named_children (self, nm):
61 return self.get_typed_children (get_class (nm))
63 def get_named_child (self, nm):
64 return self.get_maybe_exist_named_child (nm)
66 def get_children (self, predicate):
67 return [c for c in self._children if predicate(c)]
69 def get_all_children (self):
72 def get_maybe_exist_named_child (self, name):
73 return self.get_maybe_exist_typed_child (get_class (name))
75 def get_maybe_exist_typed_child (self, klass):
76 cn = self.get_typed_children (klass)
82 raise "More than 1 child", klass
84 def get_unique_typed_child (self, klass):
85 cn = self.get_typed_children(klass)
87 sys.stderr.write (self.__dict__ + '\n')
88 raise 'Child is not unique for', (klass, 'found', cn)
92 class Music_xml_node (Xml_node):
94 Xml_node.__init__ (self)
95 self.duration = Rational (0)
96 self.start = Rational (0)
98 class Work (Xml_node):
99 def get_work_information (self, tag):
100 wt = self.get_maybe_exist_named_child (tag)
102 return wt.get_text ()
106 def get_work_title (self):
107 return self.get_work_information ('work-title')
108 def get_work_number (self):
109 return self.get_work_information ('work-number')
111 return self.get_work_information ('opus')
113 class Identification (Xml_node):
114 def get_rights (self):
115 rights = self.get_maybe_exist_named_child ('rights')
117 return rights.get_text ()
121 def get_creator (self, type):
122 creators = self.get_named_children ('creator')
123 # return the first creator tag that has the particular type
125 if hasattr (i, 'type') and i.type == type:
129 def get_composer (self):
130 c = self.get_creator ('composer')
133 creators = self.get_named_children ('creator')
134 # return the first creator tag that has no type at all
136 if not hasattr (i, 'type'):
139 def get_arranger (self):
140 return self.get_creator ('arranger')
141 def get_editor (self):
142 return self.get_creator ('editor')
144 v = self.get_creator ('lyricist')
147 v = self.get_creator ('poet')
150 def get_encoding_information (self, type):
151 enc = self.get_named_children ('encoding')
153 children = enc[0].get_named_children (type)
155 return children[0].get_text ()
159 def get_encoding_software (self):
160 return self.get_encoding_information ('software')
161 def get_encoding_date (self):
162 return self.get_encoding_information ('encoding-date')
163 def get_encoding_person (self):
164 return self.get_encoding_information ('encoder')
165 def get_encoding_description (self):
166 return self.get_encoding_information ('encoding-description')
169 class Duration (Music_xml_node):
170 def get_length (self):
171 dur = int (self.get_text ()) * Rational (1,4)
174 class Hash_comment (Music_xml_node):
176 class Hash_text (Music_xml_node):
179 class Pitch (Music_xml_node):
181 ch = self.get_unique_typed_child (get_class (u'step'))
182 step = ch.get_text ().strip ()
184 def get_octave (self):
185 ch = self.get_unique_typed_child (get_class (u'octave'))
187 step = ch.get_text ().strip ()
190 def get_alteration (self):
191 ch = self.get_maybe_exist_typed_child (get_class (u'alter'))
194 alter = int (ch.get_text ().strip ())
197 class Measure_element (Music_xml_node):
198 def get_voice_id (self):
199 voice_id = self.get_maybe_exist_named_child ('voice')
201 return voice_id.get_text ()
206 cn = self._parent.get_typed_children (self.__class__)
207 cn = [c for c in cn if c.get_voice_id () == self.get_voice_id ()]
210 class Attributes (Measure_element):
212 Measure_element.__init__ (self)
215 def set_attributes_from_previous (self, dict):
216 self._dict.update (dict)
218 def read_self (self):
219 for c in self.get_all_children ():
220 self._dict[c.get_name()] = c
222 def get_named_attribute (self, name):
223 return self._dict.get (name)
225 def get_measure_length (self):
226 (n,d) = self.get_time_signature ()
227 return Rational (n,d)
229 def get_time_signature (self):
230 "return time sig as a (beat, beat-type) tuple"
233 mxl = self.get_named_attribute ('time')
235 beats = mxl.get_maybe_exist_named_child ('beats')
236 type = mxl.get_maybe_exist_named_child ('beat-type')
237 return (int (beats.get_text ()),
238 int (type.get_text ()))
242 sys.stderr.write ('error: requested time signature, but time sig unknown\n')
245 # returns clef information in the form ("cleftype", position, octave-shift)
246 def get_clef_information (self):
247 clefinfo = ['G', 2, 0]
248 mxl = self.get_named_attribute ('clef')
251 sign = mxl.get_maybe_exist_named_child ('sign')
253 clefinfo[0] = sign.get_text()
254 line = mxl.get_maybe_exist_named_child ('line')
256 clefinfo[1] = string.atoi (line.get_text ())
257 octave = mxl.get_maybe_exist_named_child ('clef-octave-change')
259 clefinfo[2] = string.atoi (octave.get_text ())
262 def get_key_signature (self):
263 "return (fifths, mode) tuple"
265 key = self.get_named_attribute ('key')
266 mode_node = key.get_maybe_exist_named_child ('mode')
269 mode = mode_node.get_text ()
271 fifths = int (key.get_maybe_exist_named_child ('fifths').get_text ())
272 return (fifths, mode)
274 class Barline (Measure_element):
276 class BarStyle (Music_xml_node):
278 class Partial (Measure_element):
279 def __init__ (self, partial):
280 Measure_element.__init__ (self)
281 self.partial = partial
283 class Note (Measure_element):
285 Measure_element.__init__ (self)
286 self.instrument_name = ''
288 def get_duration_log (self):
289 ch = self.get_maybe_exist_named_child (u'type')
292 log = ch.get_text ().strip()
303 'long': -2}.get (log, 0)
305 self.message ("Encountered note at %s without %s duration (no <type> element):" % (self.start, self.duration) )
308 def get_factor (self):
311 def get_pitches (self):
312 return self.get_typed_children (get_class (u'pitch'))
314 class Part_list (Music_xml_node):
316 Music_xml_node.__init__ (self)
317 self._id_instrument_name_dict = {}
319 def generate_id_instrument_dict (self):
321 ## not empty to make sure this happens only once.
323 for score_part in self.get_named_children ('score-part'):
324 for instr in score_part.get_named_children ('score-instrument'):
326 name = instr.get_named_child ("instrument-name")
327 mapping[id] = name.get_text ()
329 self._id_instrument_name_dict = mapping
331 def get_instrument (self, id):
332 if not self._id_instrument_name_dict:
333 self.generate_id_instrument_dict()
335 instrument_name = self._id_instrument_name_dict.get (id)
337 return instrument_name
339 sys.stderr.write ("Opps, couldn't find instrument for ID=%s\n" % id)
342 class Part_group (Music_xml_node):
344 class Score_part (Music_xml_node):
347 class Measure (Music_xml_node):
349 Music_xml_node.__init__ (self)
351 def is_implicit (self):
352 return hasattr (self, 'implicit') and self.implicit == 'yes'
353 def get_notes (self):
354 return self.get_typed_children (get_class (u'note'))
356 class Syllabic (Music_xml_node):
357 def continued (self):
358 text = self.get_text()
359 return (text == "begin") or (text == "middle")
360 class Text (Music_xml_node):
363 class Lyric (Music_xml_node):
364 def get_number (self):
365 if hasattr (self, 'number'):
370 def lyric_to_text (self):
372 syllabic = self.get_maybe_exist_typed_child (Syllabic)
374 continued = syllabic.continued ()
375 text = self.get_maybe_exist_typed_child (Text)
378 text = text.get_text()
379 # We need to convert soft hyphens to -, otherwise the ascii codec as well
380 # as lilypond will barf on that character
381 text = string.replace( text, u'\xad', '-' )
383 if text == "-" and continued:
385 elif text == "_" and continued:
387 elif continued and text:
388 return escape_ly_output_string (text) + " --"
392 return escape_ly_output_string (text)
396 class Musicxml_voice:
400 self._start_staff = None
402 self._has_lyrics = False
404 def add_element (self, e):
405 self._elements.append (e)
406 if (isinstance (e, Note)
407 and e.get_maybe_exist_typed_child (Staff)):
408 name = e.get_maybe_exist_typed_child (Staff).get_text ()
410 if not self._start_staff and not e.get_maybe_exist_typed_child (Grace):
411 self._start_staff = name
412 self._staves[name] = True
414 lyrics = e.get_typed_children (Lyric)
415 if not self._has_lyrics:
416 self.has_lyrics = len (lyrics) > 0
420 if (nr > 0) and not (nr in self._lyrics):
421 self._lyrics.append (nr)
423 def insert (self, idx, e):
424 self._elements.insert (idx, e)
426 def get_lyrics_numbers (self):
427 if (len (self._lyrics) == 0) and self._has_lyrics:
428 #only happens if none of the <lyric> tags has a number attribute
435 class Part (Music_xml_node):
437 Music_xml_node.__init__ (self)
440 def get_part_list (self):
442 while n and n.get_name() != 'score-partwise':
445 return n.get_named_child ('part-list')
447 def interpret (self):
448 """Set durations and starting points."""
450 part_list = self.get_part_list ()
453 factor = Rational (1)
455 attributes_object = None
456 measures = self.get_typed_children (Measure)
457 last_moment = Rational (-1)
458 last_measure_position = Rational (-1)
459 measure_position = Rational (0)
460 measure_start_moment = now
461 is_first_measure = True
462 prvious_measure = None
464 # implicit measures are used for artificial measures, e.g. when
465 # a repeat bar line splits a bar into two halves. In this case,
466 # don't reset the measure position to 0. They are also used for
467 # upbeats (initial value of 0 fits these, too).
468 # Also, don't reset the measure position at the end of the loop,
469 # but rather when starting the next measure (since only then do we
470 # know if the next measure is implicit and continues that measure)
471 if not m.is_implicit ():
472 # Warn about possibly overfull measures and reset the position
473 if attributes_object:
474 length = attributes_object.get_measure_length ()
475 new_now = measure_start_moment + length
477 problem = 'incomplete'
480 ## only for verbose operation.
481 if problem <> 'incomplete' and previous_measure:
482 previous_measure.message ('%s measure? Expected: %s, Difference: %s' % (problem, now, new_now - now))
484 measure_start_moment = now
485 measure_position = Rational (0)
487 for n in m.get_all_children ():
488 if isinstance (n, Hash_text):
492 if n.__class__ == Attributes:
493 n.set_attributes_from_previous (attributes_dict)
495 attributes_dict = n._dict.copy ()
496 attributes_object = n
498 factor = Rational (1,
499 int (attributes_dict.get ('divisions').get_text ()))
502 if (n.get_maybe_exist_typed_child (Duration)):
503 mxl_dur = n.get_maybe_exist_typed_child (Duration)
504 dur = mxl_dur.get_length () * factor
506 if n.get_name() == 'backup':
508 if n.get_maybe_exist_typed_child (Grace):
511 rest = n.get_maybe_exist_typed_child (Rest)
513 and attributes_object
514 and attributes_object.get_measure_length () == dur):
516 rest._is_whole_measure = True
518 if (dur > Rational (0)
519 and n.get_maybe_exist_typed_child (Chord)):
521 measure_position = last_measure_position
524 n._measure_position = measure_position
526 if dur > Rational (0):
528 last_measure_position = measure_position
530 measure_position += dur
531 elif dur < Rational (0):
532 # backup element, reset measure position
534 measure_position += dur
535 if measure_position < 0:
536 # backup went beyond the measure start => reset to 0
537 now -= measure_position
540 last_measure_position = measure_position
541 if n._name == 'note':
542 instrument = n.get_maybe_exist_named_child ('instrument')
544 n.instrument_name = part_list.get_instrument (instrument.id)
546 # Incomplete first measures are not padded, but registered as partial
548 is_first_measure = False
549 # upbeats are marked as implicit measures
550 if attributes_object and m.is_implicit ():
551 length = attributes_object.get_measure_length ()
552 measure_end = measure_start_moment + length
553 if measure_end <> now:
557 # modify attributes so that only those applying to the given staff remain
558 def extract_attributes_for_staff (part, attr, staff):
559 attributes = copy.copy (attr)
560 attributes._children = copy.copy (attr._children)
561 attributes._dict = attr._dict.copy ()
562 for c in attributes._children:
563 if hasattr (c, 'number') and c.number != staff:
564 attributes._children.remove (c)
567 def extract_voices (part):
569 measures = part.get_typed_children (Measure)
573 elements.append (Partial (m.partial))
574 elements.extend (m.get_all_children ())
575 # make sure we know all voices already so that dynamics, clefs, etc.
576 # can be assigned to the correct voices
577 voice_to_staff_dict = {}
579 voice_id = n.get_maybe_exist_named_child (u'voice')
582 vid = voice_id.get_text ()
584 staff_id = n.get_maybe_exist_named_child (u'staff')
587 sid = staff_id.get_text ()
590 if vid and not voices.has_key (vid):
591 voices[vid] = Musicxml_voice()
592 if vid and sid and not n.get_maybe_exist_typed_child (Grace):
593 if not voice_to_staff_dict.has_key (vid):
594 voice_to_staff_dict[vid] = sid
595 # invert the voice_to_staff_dict into a staff_to_voice_dict (since we
596 # need to assign staff-assigned objects like clefs, times, etc. to
597 # all the correct voices. This will never work entirely correct due
598 # to staff-switches, but that's the best we can do!
599 staff_to_voice_dict = {}
600 for (v,s) in voice_to_staff_dict.items ():
601 if not staff_to_voice_dict.has_key (s):
602 staff_to_voice_dict[s] = [v]
604 staff_to_voice_dict[s].append (v)
609 voice_id = n.get_maybe_exist_typed_child (get_class ('voice'))
611 if not (voice_id or isinstance (n, Attributes) or
612 isinstance (n, Direction) or isinstance (n, Partial) or
613 isinstance (n, Barline) ):
616 if isinstance (n, Attributes) and not start_attr:
620 if isinstance (n, Attributes):
621 # assign these only to the voices they really belongs to!
622 for (s, vids) in staff_to_voice_dict.items ():
623 staff_attributes = part.extract_attributes_for_staff (n, s)
625 voices[v].add_element (staff_attributes)
628 if isinstance (n, Partial) or isinstance (n, Barline):
629 for v in voices.keys ():
630 voices[v].add_element (n)
633 if isinstance (n, Direction):
634 staff_id = n.get_maybe_exist_named_child (u'staff')
636 staff_id = staff_id.get_text ()
638 dir_voices = staff_to_voice_dict.get (staff_id, voices.keys ())
640 dir_voices = voices.keys ()
642 voices[v].add_element (n)
645 id = voice_id.get_text ()
646 if hasattr (n, 'print-object') and getattr (n, 'print-object') == "no":
650 voices[id].add_element (n)
653 for (s, vids) in staff_to_voice_dict.items ():
654 staff_attributes = part.extract_attributes_for_staff (start_attr, s)
655 staff_attributes.read_self ()
657 voices[v].insert (0, staff_attributes)
658 voices[v]._elements[0].read_self()
660 part._voices = voices
662 def get_voices (self):
665 class Notations (Music_xml_node):
667 ts = self.get_named_children ('tied')
668 starts = [t for t in ts if t.type == 'start']
674 def get_tuplet (self):
675 return self.get_maybe_exist_typed_child (Tuplet)
677 class Time_modification(Music_xml_node):
678 def get_fraction (self):
679 b = self.get_maybe_exist_named_child ('actual-notes')
680 a = self.get_maybe_exist_named_child ('normal-notes')
681 return (int(a.get_text ()), int (b.get_text ()))
683 class Accidental (Music_xml_node):
685 Music_xml_node.__init__ (self)
686 self.editorial = False
687 self.cautionary = False
689 class Music_xml_spanner (Music_xml_node):
691 if hasattr (self, 'type'):
696 if hasattr (self, 'size'):
697 return string.atoi (self.size)
701 class Wedge (Music_xml_spanner):
704 class Tuplet (Music_xml_spanner):
707 class Slur (Music_xml_spanner):
711 class Beam (Music_xml_spanner):
713 return self.get_text ()
714 def is_primary (self):
715 return self.number == "1"
717 class Wavy_line (Music_xml_spanner):
720 class Pedal (Music_xml_spanner):
723 class Glissando (Music_xml_spanner):
726 class Octave_shift (Music_xml_spanner):
727 # default is 8 for the octave-shift!
729 if hasattr (self, 'size'):
730 return string.atoi (self.size)
734 class Chord (Music_xml_node):
737 class Dot (Music_xml_node):
740 # Rests in MusicXML are <note> blocks with a <rest> inside. This class is only
741 # for the inner <rest> element, not the whole rest block.
742 class Rest (Music_xml_node):
744 Music_xml_node.__init__ (self)
745 self._is_whole_measure = False
746 def is_whole_measure (self):
747 return self._is_whole_measure
749 ch = self.get_maybe_exist_typed_child (get_class (u'display-step'))
751 step = ch.get_text ().strip ()
755 def get_octave (self):
756 ch = self.get_maybe_exist_typed_child (get_class (u'display-octave'))
758 step = ch.get_text ().strip ()
763 class Type (Music_xml_node):
765 class Grace (Music_xml_node):
767 class Staff (Music_xml_node):
770 class Direction (Music_xml_node):
772 class DirType (Music_xml_node):
775 class Bend (Music_xml_node):
776 def bend_alter (self):
777 alter = self.get_maybe_exist_named_child ('bend-alter')
779 return alter.get_text()
785 ## need this, not all classes are instantiated
786 ## for every input file. Only add those classes, that are either directly
787 ## used by class name or extend Music_xml_node in some way!
789 '#comment': Hash_comment,
791 'accidental': Accidental,
792 'attributes': Attributes,
794 'bar-style': BarStyle,
799 'direction': Direction,
800 'direction-type': DirType,
801 'duration': Duration,
802 'glissando': Glissando,
804 'identification': Identification,
807 'notations': Notations,
809 'octave-shift': Octave_shift,
811 'part-group': Part_group,
812 'part-list': Part_list,
816 'score-part': Score_part,
819 'syllabic': Syllabic,
821 'time-modification': Time_modification,
824 'wavy-line': Wavy_line,
829 def name2class_name (name):
830 name = name.replace ('-', '_')
831 name = name.replace ('#', 'hash_')
832 name = name[0].upper() + name[1:].lower()
836 def get_class (name):
837 classname = class_dict.get (name)
841 class_name = name2class_name (name)
842 klass = new.classobj (class_name, (Music_xml_node,) , {})
843 class_dict[name] = klass
846 def lxml_demarshal_node (node):
851 klass = get_class (name)
854 py_node._original = node
856 py_node._data = node.text
857 py_node._children = [lxml_demarshal_node (cn) for cn in node.getchildren()]
858 py_node._children = filter (lambda x: x, py_node._children)
860 for c in py_node._children:
863 for (k,v) in node.items ():
864 py_node.__dict__[k] = v
865 py_node._attribute_dict[k] = v
869 def minidom_demarshal_node (node):
872 klass = get_class (name)
875 py_node._children = [minidom_demarshal_node (cn) for cn in node.childNodes]
876 for c in py_node._children:
880 for (nm, value) in node.attributes.items():
881 py_node.__dict__[nm] = value
882 py_node._attribute_dict[nm] = value
885 if node.nodeType == node.TEXT_NODE and node.data:
886 py_node._data = node.data
888 py_node._original = node
892 if __name__ == '__main__':
895 tree = lxml.etree.parse ('beethoven.xml')
896 mxl_tree = lxml_demarshal_node (tree.getroot ())
897 ks = class_dict.keys()