python/musicxml.py

   1 # -*- coding: utf-8 -*-
   2 import new
   3 import string
   4 from rational import *
   5 import re
   6 import sys
   7 import copy
   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);
  12     if needs_quotes:
  13         return_string = "\"" + string.replace (return_string, "\"", "\\\"") + "\""
  14     return return_string
  15
  16
  17 class Xml_node:
  18     def __init__ (self):
  19         self._children = []
  20         self._data = None
  21         self._original = None
  22         self._name = 'xml_node'
  23         self._parent = None
  24         self._attribute_dict = {}
  25
  26     def get_parent (self):
  27         return self._parent
  28
  29     def is_first (self):
  30         return self._parent.get_typed_children (self.__class__)[0] == self
  31
  32     def original (self):
  33         return self._original
  34     def get_name (self):
  35         return self._name
  36
  37     def get_text (self):
  38         if self._data:
  39             return self._data
  40
  41         if not self._children:
  42             return ''
  43
  44         return ''.join ([c.get_text () for c in self._children])
  45
  46     def message (self, msg):
  47         sys.stderr.write (msg+'\n')
  48
  49         p = self
  50         while p:
  51             sys.stderr.write ('  In: <%s %s>\n' % (p._name, ' '.join (['%s=%s' % item for item in p._attribute_dict.items()])))
  52             p = p.get_parent ()
  53
  54     def get_typed_children (self, klass):
  55         if not klass:
  56             return []
  57         else:
  58             return [c for c in self._children if isinstance(c, klass)]
  59
  60     def get_named_children (self, nm):
  61         return self.get_typed_children (get_class (nm))
  62
  63     def get_named_child (self, nm):
  64         return self.get_maybe_exist_named_child (nm)
  65
  66     def get_children (self, predicate):
  67         return [c for c in self._children if predicate(c)]
  68
  69     def get_all_children (self):
  70         return self._children
  71
  72     def get_maybe_exist_named_child (self, name):
  73         return self.get_maybe_exist_typed_child (get_class (name))
  74
  75     def get_maybe_exist_typed_child (self, klass):
  76         cn = self.get_typed_children (klass)
  77         if len (cn)==0:
  78             return None
  79         elif len (cn) == 1:
  80             return cn[0]
  81         else:
  82             raise "More than 1 child", klass
  83
  84     def get_unique_typed_child (self, klass):
  85         cn = self.get_typed_children(klass)
  86         if len (cn) <> 1:
  87             sys.stderr.write (self.__dict__ + '\n')
  88             raise 'Child is not unique for', (klass, 'found', cn)
  89
  90         return cn[0]
  91
  92     def get_named_child_value_number (self, name, default):
  93         n = self.get_maybe_exist_named_child (name)
  94         if n:
  95             return string.atoi (n.get_text())
  96         else:
  97             return default
  98
  99
 100 class Music_xml_node (Xml_node):
 101     def __init__ (self):
 102         Xml_node.__init__ (self)
 103         self.duration = Rational (0)
 104         self.start = Rational (0)
 105
 106 class Work (Xml_node):
 107     def get_work_information (self, tag):
 108         wt = self.get_maybe_exist_named_child (tag)
 109         if wt:
 110             return wt.get_text ()
 111         else:
 112             return ''
 113
 114     def get_work_title (self):
 115         return self.get_work_information ('work-title')
 116     def get_work_number (self):
 117         return self.get_work_information ('work-number')
 118     def get_opus (self):
 119         return self.get_work_information ('opus')
 120
 121 class Identification (Xml_node):
 122     def get_rights (self):
 123         rights = self.get_maybe_exist_named_child ('rights')
 124         if rights:
 125             return rights.get_text ()
 126         else:
 127             return ''
 128
 129     def get_creator (self, type):
 130         creators = self.get_named_children ('creator')
 131         # return the first creator tag that has the particular type
 132         for i in creators:
 133             if hasattr (i, 'type') and i.type == type:
 134                 return i.get_text ()
 135         return None
 136
 137     def get_composer (self):
 138         c = self.get_creator ('composer')
 139         if c:
 140             return c
 141         creators = self.get_named_children ('creator')
 142         # return the first creator tag that has no type at all
 143         for i in creators:
 144             if not hasattr (i, 'type'):
 145                 return i.get_text ()
 146         return None
 147     def get_arranger (self):
 148         return self.get_creator ('arranger')
 149     def get_editor (self):
 150         return self.get_creator ('editor')
 151     def get_poet (self):
 152         v = self.get_creator ('lyricist')
 153         if v:
 154             return v
 155         v = self.get_creator ('poet')
 156         return v
 157
 158     def get_encoding_information (self, type):
 159         enc = self.get_named_children ('encoding')
 160         if enc:
 161             children = enc[0].get_named_children (type)
 162             if children:
 163                 return children[0].get_text ()
 164         else:
 165             return None
 166
 167     def get_encoding_software (self):
 168         return self.get_encoding_information ('software')
 169     def get_encoding_date (self):
 170         return self.get_encoding_information ('encoding-date')
 171     def get_encoding_person (self):
 172         return self.get_encoding_information ('encoder')
 173     def get_encoding_description (self):
 174         return self.get_encoding_information ('encoding-description')
 175
 176
 177 class Duration (Music_xml_node):
 178     def get_length (self):
 179         dur = int (self.get_text ()) * Rational (1,4)
 180         return dur
 181
 182 class Hash_comment (Music_xml_node):
 183     pass
 184 class Hash_text (Music_xml_node):
 185     pass
 186
 187 class Pitch (Music_xml_node):
 188     def get_step (self):
 189         ch = self.get_unique_typed_child (get_class (u'step'))
 190         step = ch.get_text ().strip ()
 191         return step
 192     def get_octave (self):
 193         ch = self.get_unique_typed_child (get_class (u'octave'))
 194
 195         step = ch.get_text ().strip ()
 196         return int (step)
 197
 198     def get_alteration (self):
 199         ch = self.get_maybe_exist_typed_child (get_class (u'alter'))
 200         alter = 0
 201         if ch:
 202             alter = int (ch.get_text ().strip ())
 203         return alter
 204
 205 class Measure_element (Music_xml_node):
 206     def get_voice_id (self):
 207         voice_id = self.get_maybe_exist_named_child ('voice')
 208         if voice_id:
 209             return voice_id.get_text ()
 210         else:
 211             return None
 212
 213     def is_first (self):
 214         cn = self._parent.get_typed_children (self.__class__)
 215         cn = [c for c in cn if c.get_voice_id () == self.get_voice_id ()]
 216         return cn[0] == self
 217
 218 class Attributes (Measure_element):
 219     def __init__ (self):
 220         Measure_element.__init__ (self)
 221         self._dict = {}
 222
 223     def set_attributes_from_previous (self, dict):
 224         self._dict.update (dict)
 225
 226     def read_self (self):
 227         for c in self.get_all_children ():
 228             self._dict[c.get_name()] = c
 229
 230     def get_named_attribute (self, name):
 231         return self._dict.get (name)
 232
 233     def get_measure_length (self):
 234         (n,d) = self.get_time_signature ()
 235         return Rational (n,d)
 236
 237     def get_time_signature (self):
 238         "return time sig as a (beat, beat-type) tuple"
 239
 240         try:
 241             mxl = self.get_named_attribute ('time')
 242             if mxl:
 243                 beats = mxl.get_maybe_exist_named_child ('beats')
 244                 type = mxl.get_maybe_exist_named_child ('beat-type')
 245                 return (int (beats.get_text ()),
 246                         int (type.get_text ()))
 247             else:
 248                 return (4, 4)
 249         except KeyError:
 250             sys.stderr.write ('error: requested time signature, but time sig unknown\n')
 251             return (4, 4)
 252
 253     # returns clef information in the form ("cleftype", position, octave-shift)
 254     def get_clef_information (self):
 255         clefinfo = ['G', 2, 0]
 256         mxl = self.get_named_attribute ('clef')
 257         if not mxl:
 258             return clefinfo
 259         sign = mxl.get_maybe_exist_named_child ('sign')
 260         if sign:
 261             clefinfo[0] = sign.get_text()
 262         line = mxl.get_maybe_exist_named_child ('line')
 263         if line:
 264             clefinfo[1] = string.atoi (line.get_text ())
 265         octave = mxl.get_maybe_exist_named_child ('clef-octave-change')
 266         if octave:
 267             clefinfo[2] = string.atoi (octave.get_text ())
 268         return clefinfo
 269
 270     def get_key_signature (self):
 271         "return (fifths, mode) tuple"
 272
 273         key = self.get_named_attribute ('key')
 274         mode_node = key.get_maybe_exist_named_child ('mode')
 275         mode = 'major'
 276         if mode_node:
 277             mode = mode_node.get_text ()
 278
 279         fifths = int (key.get_maybe_exist_named_child ('fifths').get_text ())
 280         return (fifths, mode)
 281
 282 class Barline (Measure_element):
 283     pass
 284 class BarStyle (Music_xml_node):
 285     pass
 286 class Partial (Measure_element):
 287     def __init__ (self, partial):
 288         Measure_element.__init__ (self)
 289         self.partial = partial
 290
 291 class Note (Measure_element):
 292     def __init__ (self):
 293         Measure_element.__init__ (self)
 294         self.instrument_name = ''
 295
 296     def get_duration_log (self):
 297         ch = self.get_maybe_exist_named_child (u'type')
 298
 299         if ch:
 300             log = ch.get_text ().strip()
 301             return {'256th': 8,
 302                     '128th': 7,
 303                     '64th': 6,
 304                     '32nd': 5,
 305                     '16th': 4,
 306                     'eighth': 3,
 307                     'quarter': 2,
 308                     'half': 1,
 309                     'whole': 0,
 310                     'breve': -1,
 311                     'long': -2}.get (log, 0)
 312         else:
 313             self.message ("Encountered note at %s without %s duration (no <type> element):" % (self.start, self.duration) )
 314             return 0
 315
 316     def get_factor (self):
 317         return 1
 318
 319     def get_pitches (self):
 320         return self.get_typed_children (get_class (u'pitch'))
 321
 322 class Part_list (Music_xml_node):
 323     def __init__ (self):
 324         Music_xml_node.__init__ (self)
 325         self._id_instrument_name_dict = {}
 326
 327     def generate_id_instrument_dict (self):
 328
 329         ## not empty to make sure this happens only once.
 330         mapping = {1: 1}
 331         for score_part in self.get_named_children ('score-part'):
 332             for instr in score_part.get_named_children ('score-instrument'):
 333                 id = instr.id
 334                 name = instr.get_named_child ("instrument-name")
 335                 mapping[id] = name.get_text ()
 336
 337         self._id_instrument_name_dict = mapping
 338
 339     def get_instrument (self, id):
 340         if not self._id_instrument_name_dict:
 341             self.generate_id_instrument_dict()
 342
 343         instrument_name = self._id_instrument_name_dict.get (id)
 344         if instrument_name:
 345             return instrument_name
 346         else:
 347             sys.stderr.write ("Opps, couldn't find instrument for ID=%s\n" % id)
 348             return "Grand Piano"
 349
 350 class Part_group (Music_xml_node):
 351     pass
 352 class Score_part (Music_xml_node):
 353     pass
 354
 355 class Measure (Music_xml_node):
 356     def __init__ (self):
 357         Music_xml_node.__init__ (self)
 358         self.partial = 0
 359     def is_implicit (self):
 360         return hasattr (self, 'implicit') and self.implicit == 'yes'
 361     def get_notes (self):
 362         return self.get_typed_children (get_class (u'note'))
 363
 364 class Syllabic (Music_xml_node):
 365     def continued (self):
 366         text = self.get_text()
 367         return (text == "begin") or (text == "middle")
 368 class Text (Music_xml_node):
 369     pass
 370
 371 class Lyric (Music_xml_node):
 372     def get_number (self):
 373         if hasattr (self, 'number'):
 374             return self.number
 375         else:
 376             return -1
 377
 378     def lyric_to_text (self):
 379         continued = False
 380         syllabic = self.get_maybe_exist_typed_child (Syllabic)
 381         if syllabic:
 382             continued = syllabic.continued ()
 383         text = self.get_maybe_exist_typed_child (Text)
 384
 385         if text:
 386             text = text.get_text()
 387             # We need to convert soft hyphens to -, otherwise the ascii codec as well
 388             # as lilypond will barf on that character
 389             text = string.replace( text, u'\xad', '-' )
 390
 391         if text == "-" and continued:
 392             return "--"
 393         elif text == "_" and continued:
 394             return "__"
 395         elif continued and text:
 396             return escape_ly_output_string (text) + " --"
 397         elif continued:
 398             return "--"
 399         elif text:
 400             return escape_ly_output_string (text)
 401         else:
 402             return ""
 403
 404 class Musicxml_voice:
 405     def __init__ (self):
 406         self._elements = []
 407         self._staves = {}
 408         self._start_staff = None
 409         self._lyrics = []
 410         self._has_lyrics = False
 411
 412     def add_element (self, e):
 413         self._elements.append (e)
 414         if (isinstance (e, Note)
 415             and e.get_maybe_exist_typed_child (Staff)):
 416             name = e.get_maybe_exist_typed_child (Staff).get_text ()
 417
 418             if not self._start_staff and not e.get_maybe_exist_typed_child (Grace):
 419                 self._start_staff = name
 420             self._staves[name] = True
 421
 422         lyrics = e.get_typed_children (Lyric)
 423         if not self._has_lyrics:
 424           self.has_lyrics = len (lyrics) > 0
 425
 426         for l in lyrics:
 427             nr = l.get_number()
 428             if (nr > 0) and not (nr in self._lyrics):
 429                 self._lyrics.append (nr)
 430
 431     def insert (self, idx, e):
 432         self._elements.insert (idx, e)
 433
 434     def get_lyrics_numbers (self):
 435         if (len (self._lyrics) == 0) and self._has_lyrics:
 436             #only happens if none of the <lyric> tags has a number attribute
 437             return [1]
 438         else:
 439             return self._lyrics
 440
 441
 442
 443 class Part (Music_xml_node):
 444     def __init__ (self):
 445         Music_xml_node.__init__ (self)
 446         self._voices = []
 447
 448     def get_part_list (self):
 449         n = self
 450         while n and n.get_name() != 'score-partwise':
 451             n = n._parent
 452
 453         return n.get_named_child ('part-list')
 454
 455     def interpret (self):
 456         """Set durations and starting points."""
 457
 458         part_list = self.get_part_list ()
 459
 460         now = Rational (0)
 461         factor = Rational (1)
 462         attributes_dict = {}
 463         attributes_object = None
 464         measures = self.get_typed_children (Measure)
 465         last_moment = Rational (-1)
 466         last_measure_position = Rational (-1)
 467         measure_position = Rational (0)
 468         measure_start_moment = now
 469         is_first_measure = True
 470         prvious_measure = None
 471         for m in measures:
 472             # implicit measures are used for artificial measures, e.g. when
 473             # a repeat bar line splits a bar into two halves. In this case,
 474             # don't reset the measure position to 0. They are also used for
 475             # upbeats (initial value of 0 fits these, too).
 476             # Also, don't reset the measure position at the end of the loop,
 477             # but rather when starting the next measure (since only then do we
 478             # know if the next measure is implicit and continues that measure)
 479             if not m.is_implicit ():
 480                 # Warn about possibly overfull measures and reset the position
 481                 if attributes_object:
 482                     length = attributes_object.get_measure_length ()
 483                     new_now = measure_start_moment + length
 484                     if now <> new_now:
 485                         problem = 'incomplete'
 486                         if now > new_now:
 487                             problem = 'overfull'
 488                         ## only for verbose operation.
 489                         if problem <> 'incomplete' and previous_measure:
 490                             previous_measure.message ('%s measure? Expected: %s, Difference: %s' % (problem, now, new_now - now))
 491                     now = new_now
 492                 measure_start_moment = now
 493                 measure_position = Rational (0)
 494
 495             for n in m.get_all_children ():
 496                 if isinstance (n, Hash_text):
 497                     continue
 498                 dur = Rational (0)
 499
 500                 if n.__class__ == Attributes:
 501                     n.set_attributes_from_previous (attributes_dict)
 502                     n.read_self ()
 503                     attributes_dict = n._dict.copy ()
 504                     attributes_object = n
 505
 506                     factor = Rational (1,
 507                                        int (attributes_dict.get ('divisions').get_text ()))
 508
 509
 510                 if (n.get_maybe_exist_typed_child (Duration)):
 511                     mxl_dur = n.get_maybe_exist_typed_child (Duration)
 512                     dur = mxl_dur.get_length () * factor
 513
 514                     if n.get_name() == 'backup':
 515                         dur = - dur
 516                     if n.get_maybe_exist_typed_child (Grace):
 517                         dur = Rational (0)
 518
 519                     rest = n.get_maybe_exist_typed_child (Rest)
 520                     if (rest
 521                         and attributes_object
 522                         and attributes_object.get_measure_length () == dur):
 523
 524                         rest._is_whole_measure = True
 525
 526                 if (dur > Rational (0)
 527                     and n.get_maybe_exist_typed_child (Chord)):
 528                     now = last_moment
 529                     measure_position = last_measure_position
 530
 531                 n._when = now
 532                 n._measure_position = measure_position
 533                 n._duration = dur
 534                 if dur > Rational (0):
 535                     last_moment = now
 536                     last_measure_position = measure_position
 537                     now += dur
 538                     measure_position += dur
 539                 elif dur < Rational (0):
 540                     # backup element, reset measure position
 541                     now += dur
 542                     measure_position += dur
 543                     if measure_position < 0:
 544                         # backup went beyond the measure start => reset to 0
 545                         now -= measure_position
 546                         measure_position = 0
 547                     last_moment = now
 548                     last_measure_position = measure_position
 549                 if n._name == 'note':
 550                     instrument = n.get_maybe_exist_named_child ('instrument')
 551                     if instrument:
 552                         n.instrument_name = part_list.get_instrument (instrument.id)
 553
 554             # Incomplete first measures are not padded, but registered as partial
 555             if is_first_measure:
 556                 is_first_measure = False
 557                 # upbeats are marked as implicit measures
 558                 if attributes_object and m.is_implicit ():
 559                     length = attributes_object.get_measure_length ()
 560                     measure_end = measure_start_moment + length
 561                     if measure_end <> now:
 562                         m.partial = now
 563             previous_measure = m
 564
 565     # modify attributes so that only those applying to the given staff remain
 566     def extract_attributes_for_staff (part, attr, staff):
 567         attributes = copy.copy (attr)
 568         attributes._children = copy.copy (attr._children)
 569         attributes._dict = attr._dict.copy ()
 570         for c in attributes._children:
 571             if hasattr (c, 'number') and c.number != staff:
 572                 attributes._children.remove (c)
 573         return attributes
 574
 575     def extract_voices (part):
 576         voices = {}
 577         measures = part.get_typed_children (Measure)
 578         elements = []
 579         for m in measures:
 580             if m.partial > 0:
 581                 elements.append (Partial (m.partial))
 582             elements.extend (m.get_all_children ())
 583         # make sure we know all voices already so that dynamics, clefs, etc.
 584         # can be assigned to the correct voices
 585         voice_to_staff_dict = {}
 586         for n in elements:
 587             voice_id = n.get_maybe_exist_named_child (u'voice')
 588             vid = None
 589             if voice_id:
 590                 vid = voice_id.get_text ()
 591
 592             staff_id = n.get_maybe_exist_named_child (u'staff')
 593             sid = None
 594             if staff_id:
 595                 sid = staff_id.get_text ()
 596             else:
 597                 sid = "None"
 598             if vid and not voices.has_key (vid):
 599                 voices[vid] = Musicxml_voice()
 600             if vid and sid and not n.get_maybe_exist_typed_child (Grace):
 601                 if not voice_to_staff_dict.has_key (vid):
 602                     voice_to_staff_dict[vid] = sid
 603         # invert the voice_to_staff_dict into a staff_to_voice_dict (since we
 604         # need to assign staff-assigned objects like clefs, times, etc. to
 605         # all the correct voices. This will never work entirely correct due
 606         # to staff-switches, but that's the best we can do!
 607         staff_to_voice_dict = {}
 608         for (v,s) in voice_to_staff_dict.items ():
 609             if not staff_to_voice_dict.has_key (s):
 610                 staff_to_voice_dict[s] = [v]
 611             else:
 612                 staff_to_voice_dict[s].append (v)
 613
 614
 615         start_attr = None
 616         for n in elements:
 617             voice_id = n.get_maybe_exist_typed_child (get_class ('voice'))
 618
 619             if not (voice_id or isinstance (n, Attributes) or
 620                     isinstance (n, Direction) or isinstance (n, Partial) or
 621                     isinstance (n, Barline) or isinstance (n, Harmony) ):
 622                 continue
 623
 624             if isinstance (n, Attributes) and not start_attr:
 625                 start_attr = n
 626                 continue
 627
 628             if isinstance (n, Attributes):
 629                 # assign these only to the voices they really belongs to!
 630                 for (s, vids) in staff_to_voice_dict.items ():
 631                     staff_attributes = part.extract_attributes_for_staff (n, s)
 632                     for v in vids:
 633                         voices[v].add_element (staff_attributes)
 634                 continue
 635
 636             if isinstance (n, Partial) or isinstance (n, Barline):
 637                 for v in voices.keys ():
 638                     voices[v].add_element (n)
 639                 continue
 640
 641             if isinstance (n, Direction) or isinstance (n, Harmony):
 642                 staff_id = n.get_maybe_exist_named_child (u'staff')
 643                 if staff_id:
 644                     staff_id = staff_id.get_text ()
 645                 if staff_id:
 646                     dir_voices = staff_to_voice_dict.get (staff_id, voices.keys ())
 647                 else:
 648                     dir_voices = voices.keys ()
 649                 # assign only to first voice, otherwise we'll have duplicates!
 650                 if dir_voices:
 651                     voices[dir_voices[0]].add_element (n)
 652                 #for v in dir_voices:
 653                     #voices[v].add_element (n)
 654                 continue
 655
 656             id = voice_id.get_text ()
 657             if hasattr (n, 'print-object') and getattr (n, 'print-object') == "no":
 658                 #Skip this note.
 659                 pass
 660             else:
 661                 voices[id].add_element (n)
 662
 663         if start_attr:
 664             for (s, vids) in staff_to_voice_dict.items ():
 665                 staff_attributes = part.extract_attributes_for_staff (start_attr, s)
 666                 staff_attributes.read_self ()
 667                 for v in vids:
 668                     voices[v].insert (0, staff_attributes)
 669                     voices[v]._elements[0].read_self()
 670
 671         part._voices = voices
 672
 673     def get_voices (self):
 674         return self._voices
 675
 676 class Notations (Music_xml_node):
 677     def get_tie (self):
 678         ts = self.get_named_children ('tied')
 679         starts = [t for t in ts if t.type == 'start']
 680         if starts:
 681             return starts[0]
 682         else:
 683             return None
 684
 685     def get_tuplet (self):
 686         return self.get_maybe_exist_typed_child (Tuplet)
 687
 688 class Time_modification(Music_xml_node):
 689     def get_fraction (self):
 690         b = self.get_maybe_exist_named_child ('actual-notes')
 691         a = self.get_maybe_exist_named_child ('normal-notes')
 692         return (int(a.get_text ()), int (b.get_text ()))
 693
 694 class Accidental (Music_xml_node):
 695     def __init__ (self):
 696         Music_xml_node.__init__ (self)
 697         self.editorial = False
 698         self.cautionary = False
 699
 700 class Music_xml_spanner (Music_xml_node):
 701     def get_type (self):
 702         if hasattr (self, 'type'):
 703             return self.type
 704         else:
 705             return 0
 706     def get_size (self):
 707         if hasattr (self, 'size'):
 708             return string.atoi (self.size)
 709         else:
 710             return 0
 711
 712 class Wedge (Music_xml_spanner):
 713     pass
 714
 715 class Tuplet (Music_xml_spanner):
 716     pass
 717
 718 class Slur (Music_xml_spanner):
 719     def get_type (self):
 720         return self.type
 721
 722 class Beam (Music_xml_spanner):
 723     def get_type (self):
 724         return self.get_text ()
 725     def is_primary (self):
 726         return self.number == "1"
 727
 728 class Wavy_line (Music_xml_spanner):
 729     pass
 730
 731 class Pedal (Music_xml_spanner):
 732     pass
 733
 734 class Glissando (Music_xml_spanner):
 735     pass
 736
 737 class Octave_shift (Music_xml_spanner):
 738     # default is 8 for the octave-shift!
 739     def get_size (self):
 740         if hasattr (self, 'size'):
 741             return string.atoi (self.size)
 742         else:
 743             return 8
 744
 745 class Chord (Music_xml_node):
 746     pass
 747
 748 class Dot (Music_xml_node):
 749     pass
 750
 751 # Rests in MusicXML are <note> blocks with a <rest> inside. This class is only
 752 # for the inner <rest> element, not the whole rest block.
 753 class Rest (Music_xml_node):
 754     def __init__ (self):
 755         Music_xml_node.__init__ (self)
 756         self._is_whole_measure = False
 757     def is_whole_measure (self):
 758         return self._is_whole_measure
 759     def get_step (self):
 760         ch = self.get_maybe_exist_typed_child (get_class (u'display-step'))
 761         if ch:
 762             step = ch.get_text ().strip ()
 763             return step
 764         else:
 765             return None
 766     def get_octave (self):
 767         ch = self.get_maybe_exist_typed_child (get_class (u'display-octave'))
 768         if ch:
 769             step = ch.get_text ().strip ()
 770             return int (step)
 771         else:
 772             return None
 773
 774 class Type (Music_xml_node):
 775     pass
 776 class Grace (Music_xml_node):
 777     pass
 778 class Staff (Music_xml_node):
 779     pass
 780
 781 class Direction (Music_xml_node):
 782     pass
 783 class DirType (Music_xml_node):
 784     pass
 785
 786 class Bend (Music_xml_node):
 787     def bend_alter (self):
 788         alter = self.get_maybe_exist_named_child ('bend-alter')
 789         if alter:
 790             return alter.get_text()
 791         else:
 792             return 0
 793
 794 class Words (Music_xml_node):
 795     pass
 796
 797 class Harmony (Music_xml_node):
 798     pass
 799
 800 class Frame (Music_xml_node):
 801     def get_frets (self):
 802         return self.get_named_child_value_number ('frame-frets', 4)
 803     def get_strings (self):
 804         return self.get_named_child_value_number ('frame-strings', 6)
 805     def get_first_fret (self):
 806         return self.get_named_child_value_number ('first-fret', 1)
 807 class Frame_Note (Music_xml_node):
 808     def get_string (self):
 809         return self.get_named_child_value_number ('string', 1)
 810     def get_fret (self):
 811         return self.get_named_child_value_number ('fret', 0)
 812     def get_fingering (self):
 813         return self.get_named_child_value_number ('fingering', -1)
 814     def get_barre (self):
 815         n = self.get_maybe_exist_named_child ('barre')
 816         if n:
 817             return getattr (n, 'type', '')
 818         else:
 819             return ''
 820
 821
 822 ## need this, not all classes are instantiated
 823 ## for every input file. Only add those classes, that are either directly
 824 ## used by class name or extend Music_xml_node in some way!
 825 class_dict = {
 826         '#comment': Hash_comment,
 827         '#text': Hash_text,
 828         'accidental': Accidental,
 829         'attributes': Attributes,
 830         'barline': Barline,
 831         'bar-style': BarStyle,
 832         'beam' : Beam,
 833         'bend' : Bend,
 834         'chord': Chord,
 835         'dot': Dot,
 836         'direction': Direction,
 837         'direction-type': DirType,
 838         'duration': Duration,
 839         'frame': Frame,
 840         'frame-note': Frame_Note,
 841         'glissando': Glissando,
 842         'grace': Grace,
 843         'harmony': Harmony,
 844         'identification': Identification,
 845         'lyric': Lyric,
 846         'measure': Measure,
 847         'notations': Notations,
 848         'note': Note,
 849         'octave-shift': Octave_shift,
 850         'part': Part,
 851     'part-group': Part_group,
 852         'part-list': Part_list,
 853         'pedal': Pedal,
 854         'pitch': Pitch,
 855         'rest': Rest,
 856     'score-part': Score_part,
 857         'slur': Slur,
 858         'staff': Staff,
 859         'syllabic': Syllabic,
 860         'text': Text,
 861         'time-modification': Time_modification,
 862         'tuplet': Tuplet,
 863         'type': Type,
 864         'wavy-line': Wavy_line,
 865         'wedge': Wedge,
 866         'words': Words,
 867         'work': Work,
 868 }
 869
 870 def name2class_name (name):
 871     name = name.replace ('-', '_')
 872     name = name.replace ('#', 'hash_')
 873     name = name[0].upper() + name[1:].lower()
 874
 875     return str (name)
 876
 877 def get_class (name):
 878     classname = class_dict.get (name)
 879     if classname:
 880         return classname
 881     else:
 882         class_name = name2class_name (name)
 883         klass = new.classobj (class_name, (Music_xml_node,) , {})
 884         class_dict[name] = klass
 885         return klass
 886
 887 def lxml_demarshal_node (node):
 888     name = node.tag
 889
 890     if name is None:
 891         return None
 892     klass = get_class (name)
 893     py_node = klass()
 894
 895     py_node._original = node
 896     py_node._name = name
 897     py_node._data = node.text
 898     py_node._children = [lxml_demarshal_node (cn) for cn in node.getchildren()]
 899     py_node._children = filter (lambda x: x, py_node._children)
 900
 901     for c in py_node._children:
 902         c._parent = py_node
 903
 904     for (k,v) in node.items ():
 905         py_node.__dict__[k] = v
 906         py_node._attribute_dict[k] = v
 907
 908     return py_node
 909
 910 def minidom_demarshal_node (node):
 911     name = node.nodeName
 912
 913     klass = get_class (name)
 914     py_node = klass()
 915     py_node._name = name
 916     py_node._children = [minidom_demarshal_node (cn) for cn in node.childNodes]
 917     for c in py_node._children:
 918         c._parent = py_node
 919
 920     if node.attributes:
 921         for (nm, value) in node.attributes.items():
 922             py_node.__dict__[nm] = value
 923             py_node._attribute_dict[nm] = value
 924
 925     py_node._data = None
 926     if node.nodeType == node.TEXT_NODE and node.data:
 927         py_node._data = node.data
 928
 929     py_node._original = node
 930     return py_node
 931
 932
 933 if __name__  == '__main__':
 934         import lxml.etree
 935
 936         tree = lxml.etree.parse ('beethoven.xml')
 937         mxl_tree = lxml_demarshal_node (tree.getroot ())
 938         ks = class_dict.keys()
 939         ks.sort()
 940         print '\n'.join (ks)