scripts/musicxml2ly.py

   1 #!@TARGET_PYTHON@
   2
   3 import optparse
   4 import sys
   5 import re
   6 import os
   7 import string
   8 import codecs
   9 import zipfile
  10 import StringIO
  11 from gettext import gettext as _
  12
  13 """
  14 @relocate-preamble@
  15 """
  16
  17 import lilylib as ly
  18
  19 import musicxml
  20 import musicexp
  21
  22 from rational import Rational
  23
  24 # Store command-line options in a global variable, so we can access them everythwere
  25 options = None
  26
  27 def progress (str):
  28     ly.stderr_write (str + '\n')
  29     sys.stderr.flush ()
  30
  31 def error_message (str):
  32     ly.stderr_write (str + '\n')
  33     sys.stderr.flush ()
  34
  35 needed_additional_definitions = []
  36 additional_definitions = {
  37   "snappizzicato": """#(define-markup-command (snappizzicato layout props) ()
  38   (interpret-markup layout props
  39     (markup #:stencil
  40       (ly:stencil-translate-axis
  41         (ly:stencil-add
  42           (make-circle-stencil 0.7 0.1 #f)
  43           (ly:make-stencil
  44             (list 'draw-line 0.1 0 0.1 0 1)
  45             '(-0.1 . 0.1) '(0.1 . 1)
  46           )
  47         )
  48         0.7 X
  49       )
  50     )
  51   )
  52 )
  53 """
  54 }
  55
  56 def round_to_two_digits (val):
  57     return round (val * 100) / 100
  58
  59 def extract_layout_information (tree):
  60     paper = musicexp.Paper ()
  61     defaults = tree.get_maybe_exist_named_child ('defaults')
  62     if not defaults:
  63         return None
  64     tenths = -1
  65     scaling = defaults.get_maybe_exist_named_child ('scaling')
  66     if scaling:
  67         mm = scaling.get_named_child ('millimeters')
  68         mm = string.atof (mm.get_text ())
  69         tn = scaling.get_maybe_exist_named_child ('tenths')
  70         tn = string.atof (tn.get_text ())
  71         tenths = mm / tn
  72         paper.global_staff_size = mm * 72.27 / 25.4
  73     # We need the scaling (i.e. the size of staff tenths for everything!
  74     if tenths < 0:
  75         return None
  76
  77     def from_tenths (txt):
  78         return round_to_two_digits (string.atof (txt) * tenths / 10)
  79     def set_paper_variable (varname, parent, element_name):
  80         el = parent.get_maybe_exist_named_child (element_name)
  81         if el: # Convert to cm from tenths
  82             setattr (paper, varname, from_tenths (el.get_text ()))
  83
  84     pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
  85     if pagelayout:
  86         # TODO: How can one have different margins for even and odd pages???
  87         set_paper_variable ("page_height", pagelayout, 'page-height')
  88         set_paper_variable ("page_width", pagelayout, 'page-width')
  89
  90         pmargins = pagelayout.get_named_children ('page-margins')
  91         for pm in pmargins:
  92             set_paper_variable ("left_margin", pm, 'left-margin')
  93             set_paper_variable ("right_margin", pm, 'right-margin')
  94             set_paper_variable ("bottom_margin", pm, 'bottom-margin')
  95             set_paper_variable ("top_margin", pm, 'top-margin')
  96
  97     systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
  98     if systemlayout:
  99         sl = systemlayout.get_maybe_exist_named_child ('system-margins')
 100         if sl:
 101             set_paper_variable ("system_left_margin", sl, 'left-margin')
 102             set_paper_variable ("system_right_margin", sl, 'right-margin')
 103         set_paper_variable ("system_distance", systemlayout, 'system-distance')
 104         set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
 105
 106     stafflayout = defaults.get_named_children ('staff-layout')
 107     for sl in stafflayout:
 108         nr = getattr (sl, 'number', 1)
 109         dist = sl.get_named_child ('staff-distance')
 110         #TODO: the staff distance needs to be set in the Staff context!!!
 111
 112     # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
 113     appearance = defaults.get_named_child ('appearance')
 114     if appearance:
 115         lws = appearance.get_named_children ('line-width')
 116         for lw in lws:
 117             # Possible types are: beam, bracket, dashes,
 118             #    enclosure, ending, extend, heavy barline, leger,
 119             #    light barline, octave shift, pedal, slur middle, slur tip,
 120             #    staff, stem, tie middle, tie tip, tuplet bracket, and wedge
 121             tp = lw.type
 122             w = from_tenths (lw.get_text  ())
 123             # TODO: Do something with these values!
 124         nss = appearance.get_named_children ('note-size')
 125         for ns in nss:
 126             # Possible types are: cue, grace and large
 127             tp = ns.type
 128             sz = from_tenths (ns.get_text ())
 129             # TODO: Do something with these values!
 130         # <other-appearance> elements have no specified meaning
 131
 132     rawmusicfont = defaults.get_named_child ('music-font')
 133     if rawmusicfont:
 134         # TODO: Convert the font
 135         pass
 136     rawwordfont = defaults.get_named_child ('word-font')
 137     if rawwordfont:
 138         # TODO: Convert the font
 139         pass
 140     rawlyricsfonts = defaults.get_named_children ('lyric-font')
 141     for lyricsfont in rawlyricsfonts:
 142         # TODO: Convert the font
 143         pass
 144
 145     return paper
 146
 147
 148
 149 # score information is contained in the <work>, <identification> or <movement-title> tags
 150 # extract those into a hash, indexed by proper lilypond header attributes
 151 def extract_score_information (tree):
 152     header = musicexp.Header ()
 153     def set_if_exists (field, value):
 154         if value:
 155             header.set_field (field, musicxml.escape_ly_output_string (value))
 156
 157     work = tree.get_maybe_exist_named_child ('work')
 158     if work:
 159         set_if_exists ('title', work.get_work_title ())
 160         set_if_exists ('worknumber', work.get_work_number ())
 161         set_if_exists ('opus', work.get_opus ())
 162     else:
 163         movement_title = tree.get_maybe_exist_named_child ('movement-title')
 164         if movement_title:
 165             set_if_exists ('title', movement_title.get_text ())
 166
 167     identifications = tree.get_named_children ('identification')
 168     for ids in identifications:
 169         set_if_exists ('copyright', ids.get_rights ())
 170         set_if_exists ('composer', ids.get_composer ())
 171         set_if_exists ('arranger', ids.get_arranger ())
 172         set_if_exists ('editor', ids.get_editor ())
 173         set_if_exists ('poet', ids.get_poet ())
 174
 175         set_if_exists ('tagline', ids.get_encoding_software ())
 176         set_if_exists ('encodingsoftware', ids.get_encoding_software ())
 177         set_if_exists ('encodingdate', ids.get_encoding_date ())
 178         set_if_exists ('encoder', ids.get_encoding_person ())
 179         set_if_exists ('encodingdescription', ids.get_encoding_description ())
 180
 181     return header
 182
 183 class PartGroupInfo:
 184     def __init__ (self):
 185         self.start = {}
 186         self.end = {}
 187     def is_empty (self):
 188         return len (self.start) + len (self.end) == 0
 189     def add_start (self, g):
 190         self.start[getattr (g, 'number', "1")] = g
 191     def add_end (self, g):
 192         self.end[getattr (g, 'number', "1")] = g
 193     def print_ly (self, printer):
 194         error_message ("Unprocessed PartGroupInfo %s encountered" % self)
 195     def ly_expression (self):
 196         error_message ("Unprocessed PartGroupInfo %s encountered" % self)
 197         return ''
 198
 199 def staff_attributes_to_string_tunings (mxl_attr):
 200     details = mxl_attr.get_maybe_exist_named_child ('staff-details')
 201     if not details:
 202         return []
 203     lines = 6
 204     staff_lines = details.get_maybe_exist_named_child ('staff-lines')
 205     if staff_lines:
 206         lines = string.atoi (staff_lines.get_text ())
 207
 208     tunings = [0]*lines
 209     staff_tunings = details.get_named_children ('staff-tuning')
 210     for i in staff_tunings:
 211         p = musicexp.Pitch()
 212         line = 0
 213         try:
 214             line = string.atoi (i.line) - 1
 215         except ValueError:
 216             pass
 217         tunings[line] = p
 218
 219         step = i.get_named_child (u'tuning-step')
 220         step = step.get_text ().strip ()
 221         p.step = musicxml_step_to_lily (step)
 222
 223         octave = i.get_named_child (u'tuning-octave')
 224         octave = octave.get_text ().strip ()
 225         p.octave = int (octave) - 4
 226
 227         alter = i.get_named_child (u'tuning-alter')
 228         if alter:
 229             p.alteration = int (alter.get_text ().strip ())
 230     # lilypond seems to use the opposite ordering than MusicXML...
 231     tunings.reverse ()
 232
 233     return tunings
 234
 235
 236 def staff_attributes_to_lily_staff (mxl_attr):
 237     if not mxl_attr:
 238         return musicexp.Staff ()
 239
 240     (staff_id, attributes) = mxl_attr.items ()[0]
 241
 242     # distinguish by clef:
 243     # percussion (percussion and rhythmic), tab, and everything else
 244     clef_sign = None
 245     clef = attributes.get_maybe_exist_named_child ('clef')
 246     if clef:
 247         sign = clef.get_maybe_exist_named_child ('sign')
 248         if sign:
 249             clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
 250
 251     lines = 5
 252     details = attributes.get_maybe_exist_named_child ('staff-details')
 253     if details:
 254         staff_lines = details.get_maybe_exist_named_child ('staff-lines')
 255         if staff_lines:
 256             lines = string.atoi (staff_lines.get_text ())
 257
 258     staff = None
 259     if clef_sign == "percussion" and lines == 1:
 260         staff = musicexp.RhythmicStaff ()
 261     elif clef_sign == "percussion":
 262         staff = musicexp.DrumStaff ()
 263         # staff.drum_style_table = ???
 264     elif clef_sign == "tab":
 265         staff = musicexp.TabStaff ()
 266         staff.string_tunings = staff_attributes_to_string_tunings (attributes)
 267         # staff.tablature_format = ???
 268     else:
 269         # TODO: Handle case with lines <> 5!
 270         staff = musicexp.Staff ()
 271
 272     return staff
 273
 274
 275 def extract_score_layout (part_list, staffinfo):
 276     layout = musicexp.StaffGroup (None)
 277     if not part_list:
 278         return layout
 279
 280     def read_score_part (el):
 281         if not isinstance (el, musicxml.Score_part):
 282             return
 283         # Depending on the attributes of the first measure, we create different
 284         # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
 285         staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
 286         if not staff:
 287             return None
 288         staff.id = el.id
 289         partname = el.get_maybe_exist_named_child ('part-name')
 290         # Finale gives unnamed parts the name "MusicXML Part" automatically!
 291         if partname and partname.get_text() != "MusicXML Part":
 292             staff.instrument_name = partname.get_text ()
 293         if el.get_maybe_exist_named_child ('part-abbreviation'):
 294             staff.short_instrument_name = el.get_maybe_exist_named_child ('part-abbreviation').get_text ()
 295         # TODO: Read in the MIDI device / instrument
 296         return staff
 297
 298     def read_score_group (el):
 299         if not isinstance (el, musicxml.Part_group):
 300             return
 301         group = musicexp.StaffGroup ()
 302         if hasattr (el, 'number'):
 303             id = el.number
 304             group.id = id
 305             #currentgroups_dict[id] = group
 306             #currentgroups.append (id)
 307         if el.get_maybe_exist_named_child ('group-name'):
 308             group.instrument_name = el.get_maybe_exist_named_child ('group-name').get_text ()
 309         if el.get_maybe_exist_named_child ('group-abbreviation'):
 310             group.short_instrument_name = el.get_maybe_exist_named_child ('group-abbreviation').get_text ()
 311         if el.get_maybe_exist_named_child ('group-symbol'):
 312             group.symbol = el.get_maybe_exist_named_child ('group-symbol').get_text ()
 313         if el.get_maybe_exist_named_child ('group-barline'):
 314             group.spanbar = el.get_maybe_exist_named_child ('group-barline').get_text ()
 315         return group
 316
 317
 318     parts_groups = part_list.get_all_children ()
 319
 320     # the start/end group tags are not necessarily ordered correctly and groups
 321     # might even overlap, so we can't go through the children sequentially!
 322
 323     # 1) Replace all Score_part objects by their corresponding Staff objects,
 324     #    also collect all group start/stop points into one PartGroupInfo object
 325     staves = []
 326     group_info = PartGroupInfo ()
 327     for el in parts_groups:
 328         if isinstance (el, musicxml.Score_part):
 329             if not group_info.is_empty ():
 330                 staves.append (group_info)
 331                 group_info = PartGroupInfo ()
 332             staff = read_score_part (el)
 333             if staff:
 334                 staves.append (staff)
 335         elif isinstance (el, musicxml.Part_group):
 336             if el.type == "start":
 337                 group_info.add_start (el)
 338             elif el.type == "stop":
 339                 group_info.add_end (el)
 340     if not group_info.is_empty ():
 341         staves.append (group_info)
 342
 343     # 2) Now, detect the groups:
 344     group_starts = []
 345     pos = 0
 346     while pos < len (staves):
 347         el = staves[pos]
 348         if isinstance (el, PartGroupInfo):
 349             prev_start = 0
 350             if len (group_starts) > 0:
 351                 prev_start = group_starts[-1]
 352             elif len (el.end) > 0: # no group to end here
 353                 el.end = {}
 354             if len (el.end) > 0: # closes an existing group
 355                 ends = el.end.keys ()
 356                 prev_started = staves[prev_start].start.keys ()
 357                 grpid = None
 358                 intersection = filter(lambda x:x in ends, prev_started)
 359                 if len (intersection) > 0:
 360                     grpid = intersection[0]
 361                 else:
 362                     # Close the last started group
 363                     grpid = staves[prev_start].start.keys () [0]
 364                     # Find the corresponding closing tag and remove it!
 365                     j = pos + 1
 366                     foundclosing = False
 367                     while j < len (staves) and not foundclosing:
 368                         if isinstance (staves[j], PartGroupInfo) and staves[j].end.has_key (grpid):
 369                             foundclosing = True
 370                             del staves[j].end[grpid]
 371                             if staves[j].is_empty ():
 372                                 del staves[j]
 373                         j += 1
 374                 grpobj = staves[prev_start].start[grpid]
 375                 group = read_score_group (grpobj)
 376                 # remove the id from both the start and end
 377                 if el.end.has_key (grpid):
 378                     del el.end[grpid]
 379                 del staves[prev_start].start[grpid]
 380                 if el.is_empty ():
 381                     del staves[pos]
 382                 # replace the staves with the whole group
 383                 for j in staves[(prev_start + 1):pos]:
 384                     if j.is_group:
 385                         j.stafftype = "InnerStaffGroup"
 386                     group.append_staff (j)
 387                 del staves[(prev_start + 1):pos]
 388                 staves.insert (prev_start + 1, group)
 389                 # reset pos so that we continue at the correct position
 390                 pos = prev_start
 391                 # remove an empty start group
 392                 if staves[prev_start].is_empty ():
 393                     del staves[prev_start]
 394                     group_starts.remove (prev_start)
 395                     pos -= 1
 396             elif len (el.start) > 0: # starts new part groups
 397                 group_starts.append (pos)
 398         pos += 1
 399
 400     if len (staves) == 1:
 401         return staves[0]
 402     for i in staves:
 403         layout.append_staff (i)
 404     return layout
 405
 406
 407
 408 def musicxml_duration_to_lily (mxl_note):
 409     d = musicexp.Duration ()
 410     # if the note has no Type child, then that method spits out a warning and
 411     # returns 0, i.e. a whole note
 412     d.duration_log = mxl_note.get_duration_log ()
 413
 414     d.dots = len (mxl_note.get_typed_children (musicxml.Dot))
 415     # Grace notes by specification have duration 0, so no time modification
 416     # factor is possible. It even messes up the output with *0/1
 417     if not mxl_note.get_maybe_exist_typed_child (musicxml.Grace):
 418         d.factor = mxl_note._duration / d.get_length ()
 419
 420     return d
 421
 422 def rational_to_lily_duration (rational_len):
 423     d = musicexp.Duration ()
 424     d.duration_log = {1: 0, 2: 1, 4:2, 8:3, 16:4, 32:5, 64:6, 128:7, 256:8, 512:9}.get (rational_len.denominator (), -1)
 425     d.factor = Rational (rational_len.numerator ())
 426     if d.duration_log < 0:
 427         error_message ("Encountered rational duration with denominator %s, "
 428                        "unable to convert to lilypond duration" %
 429                        rational_len.denominator ())
 430         # TODO: Test the above error message
 431         return None
 432     else:
 433         return d
 434
 435 def musicxml_partial_to_lily (partial_len):
 436     if partial_len > 0:
 437         p = musicexp.Partial ()
 438         p.partial = rational_to_lily_duration (partial_len)
 439         return p
 440     else:
 441         return Null
 442
 443 # Detect repeats and alternative endings in the chord event list (music_list)
 444 # and convert them to the corresponding musicexp objects, containing nested
 445 # music
 446 def group_repeats (music_list):
 447     repeat_replaced = True
 448     music_start = 0
 449     i = 0
 450     # Walk through the list of expressions, looking for repeat structure
 451     # (repeat start/end, corresponding endings). If we find one, try to find the
 452     # last event of the repeat, replace the whole structure and start over again.
 453     # For nested repeats, as soon as we encounter another starting repeat bar,
 454     # treat that one first, and start over for the outer repeat.
 455     while repeat_replaced and i < 100:
 456         i += 1
 457         repeat_start = -1  # position of repeat start / end
 458         repeat_end = -1 # position of repeat start / end
 459         repeat_times = 0
 460         ending_start = -1 # position of current ending start
 461         endings = [] # list of already finished endings
 462         pos = 0
 463         last = len (music_list) - 1
 464         repeat_replaced = False
 465         final_marker = 0
 466         while pos < len (music_list) and not repeat_replaced:
 467             e = music_list[pos]
 468             repeat_finished = False
 469             if isinstance (e, RepeatMarker):
 470                 if not repeat_times and e.times:
 471                     repeat_times = e.times
 472                 if e.direction == -1:
 473                     if repeat_end >= 0:
 474                         repeat_finished = True
 475                     else:
 476                         repeat_start = pos
 477                         repeat_end = -1
 478                         ending_start = -1
 479                         endings = []
 480                 elif e.direction == 1:
 481                     if repeat_start < 0:
 482                         repeat_start = 0
 483                     if repeat_end < 0:
 484                         repeat_end = pos
 485                     final_marker = pos
 486             elif isinstance (e, EndingMarker):
 487                 if e.direction == -1:
 488                     if repeat_start < 0:
 489                         repeat_start = 0
 490                     if repeat_end < 0:
 491                         repeat_end = pos
 492                     ending_start = pos
 493                 elif e.direction == 1:
 494                     if ending_start < 0:
 495                         ending_start = 0
 496                     endings.append ([ending_start, pos])
 497                     ending_start = -1
 498                     final_marker = pos
 499             elif not isinstance (e, musicexp.BarLine):
 500                 # As soon as we encounter an element when repeat start and end
 501                 # is set and we are not inside an alternative ending,
 502                 # this whole repeat structure is finished => replace it
 503                 if repeat_start >= 0 and repeat_end > 0 and ending_start < 0:
 504                     repeat_finished = True
 505
 506             # Finish off all repeats without explicit ending bar (e.g. when
 507             # we convert only one page of a multi-page score with repeats)
 508             if pos == last and repeat_start >= 0:
 509                 repeat_finished = True
 510                 final_marker = pos
 511                 if repeat_end < 0:
 512                     repeat_end = pos
 513                 if ending_start >= 0:
 514                     endings.append ([ending_start, pos])
 515                     ending_start = -1
 516
 517             if repeat_finished:
 518                 # We found the whole structure replace it!
 519                 r = musicexp.RepeatedMusic ()
 520                 if repeat_times <= 0:
 521                     repeat_times = 2
 522                 r.repeat_count = repeat_times
 523                 # don't erase the first element for "implicit" repeats (i.e. no
 524                 # starting repeat bars at the very beginning)
 525                 start = repeat_start+1
 526                 if repeat_start == music_start:
 527                     start = music_start
 528                 r.set_music (music_list[start:repeat_end])
 529                 for (start, end) in endings:
 530                     s = musicexp.SequentialMusic ()
 531                     s.elements = music_list[start+1:end]
 532                     r.add_ending (s)
 533                 del music_list[repeat_start:final_marker+1]
 534                 music_list.insert (repeat_start, r)
 535                 repeat_replaced = True
 536             pos += 1
 537         # TODO: Implement repeats until the end without explicit ending bar
 538     return music_list
 539
 540
 541
 542 def group_tuplets (music_list, events):
 543
 544
 545     """Collect Musics from
 546     MUSIC_LIST demarcated by EVENTS_LIST in TimeScaledMusic objects.
 547     """
 548
 549
 550     indices = []
 551
 552     j = 0
 553     for (ev_chord, tuplet_elt, fraction) in events:
 554         while (j < len (music_list)):
 555             if music_list[j] == ev_chord:
 556                 break
 557             j += 1
 558         if tuplet_elt.type == 'start':
 559             indices.append ((j, None, fraction))
 560         elif tuplet_elt.type == 'stop':
 561             indices[-1] = (indices[-1][0], j, indices[-1][2])
 562
 563     new_list = []
 564     last = 0
 565     for (i1, i2, frac) in indices:
 566         if i1 >= i2:
 567             continue
 568
 569         new_list.extend (music_list[last:i1])
 570         seq = musicexp.SequentialMusic ()
 571         last = i2 + 1
 572         seq.elements = music_list[i1:last]
 573
 574         tsm = musicexp.TimeScaledMusic ()
 575         tsm.element = seq
 576
 577         tsm.numerator = frac[0]
 578         tsm.denominator  = frac[1]
 579
 580         new_list.append (tsm)
 581
 582     new_list.extend (music_list[last:])
 583     return new_list
 584
 585
 586 def musicxml_clef_to_lily (attributes):
 587     change = musicexp.ClefChange ()
 588     (change.type, change.position, change.octave) = attributes.get_clef_information ()
 589     return change
 590
 591 def musicxml_time_to_lily (attributes):
 592     (beats, type) = attributes.get_time_signature ()
 593
 594     change = musicexp.TimeSignatureChange()
 595     change.fraction = (beats, type)
 596
 597     return change
 598
 599 def musicxml_key_to_lily (attributes):
 600     start_pitch  = musicexp.Pitch ()
 601     (fifths, mode) = attributes.get_key_signature ()
 602     try:
 603         (n,a) = {
 604             'major' : (0,0),
 605             'minor' : (5,0),
 606             }[mode]
 607         start_pitch.step = n
 608         start_pitch.alteration = a
 609     except  KeyError:
 610         error_message ('unknown mode %s' % mode)
 611
 612     fifth = musicexp.Pitch()
 613     fifth.step = 4
 614     if fifths < 0:
 615         fifths *= -1
 616         fifth.step *= -1
 617         fifth.normalize ()
 618
 619     for x in range (fifths):
 620         start_pitch = start_pitch.transposed (fifth)
 621
 622     start_pitch.octave = 0
 623
 624     change = musicexp.KeySignatureChange()
 625     change.mode = mode
 626     change.tonic = start_pitch
 627     return change
 628
 629 def musicxml_attributes_to_lily (attrs):
 630     elts = []
 631     attr_dispatch =  {
 632         'clef': musicxml_clef_to_lily,
 633         'time': musicxml_time_to_lily,
 634         'key': musicxml_key_to_lily
 635     }
 636     for (k, func) in attr_dispatch.items ():
 637         children = attrs.get_named_children (k)
 638         if children:
 639             elts.append (func (attrs))
 640
 641     return elts
 642
 643 class Marker (musicexp.Music):
 644     def __init__ (self):
 645         self.direction = 0
 646         self.event = None
 647     def print_ly (self, printer):
 648         sys.stderr.write ("Encountered unprocessed marker %s\n" % self)
 649         pass
 650     def ly_expression (self):
 651         return ""
 652 class RepeatMarker (Marker):
 653     def __init__ (self):
 654         Marker.__init__ (self)
 655         self.times = 0
 656 class EndingMarker (Marker):
 657     pass
 658
 659 # Convert the <barline> element to musicxml.BarLine (for non-standard barlines)
 660 # and to RepeatMarker and EndingMarker objects for repeat and
 661 # alternatives start/stops
 662 def musicxml_barline_to_lily (barline):
 663     # retval contains all possible markers in the order:
 664     # 0..bw_ending, 1..bw_repeat, 2..barline, 3..fw_repeat, 4..fw_ending
 665     retval = {}
 666     bartype_element = barline.get_maybe_exist_named_child ("bar-style")
 667     repeat_element = barline.get_maybe_exist_named_child ("repeat")
 668     ending_element = barline.get_maybe_exist_named_child ("ending")
 669
 670     bartype = None
 671     if bartype_element:
 672         bartype = bartype_element.get_text ()
 673
 674     if repeat_element and hasattr (repeat_element, 'direction'):
 675         repeat = RepeatMarker ()
 676         repeat.direction = {"forward": -1, "backward": 1}.get (repeat_element.direction, 0)
 677
 678         if ( (repeat_element.direction == "forward" and bartype == "heavy-light") or
 679              (repeat_element.direction == "backward" and bartype == "light-heavy") ):
 680             bartype = None
 681         if hasattr (repeat_element, 'times'):
 682             try:
 683                 repeat.times = int (repeat_element.times)
 684             except ValueError:
 685                 repeat.times = 2
 686         repeat.event = barline
 687         if repeat.direction == -1:
 688             retval[3] = repeat
 689         else:
 690             retval[1] = repeat
 691
 692     if ending_element and hasattr (ending_element, 'type'):
 693         ending = EndingMarker ()
 694         ending.direction = {"start": -1, "stop": 1, "discontinue": 1}.get (ending_element.type, 0)
 695         ending.event = barline
 696         if ending.direction == -1:
 697             retval[4] = ending
 698         else:
 699             retval[0] = ending
 700
 701     if bartype:
 702         b = musicexp.BarLine ()
 703         b.type = bartype
 704         retval[2] = b
 705
 706     return retval.values ()
 707
 708 spanner_event_dict = {
 709     'slur' : musicexp.SlurEvent,
 710     'beam' : musicexp.BeamEvent,
 711     'glissando' : musicexp.GlissandoEvent,
 712     'pedal' : musicexp.PedalEvent,
 713     'wavy-line' : musicexp.TrillSpanEvent,
 714     'octave-shift' : musicexp.OctaveShiftEvent,
 715     'wedge' : musicexp.HairpinEvent
 716 }
 717 spanner_type_dict = {
 718     'start': -1,
 719     'begin': -1,
 720     'crescendo': -1,
 721     'decreschendo': -1,
 722     'diminuendo': -1,
 723     'continue': 0,
 724     'up': -1,
 725     'down': -1,
 726     'stop': 1,
 727     'end' : 1
 728 }
 729
 730 def musicxml_spanner_to_lily_event (mxl_event):
 731     ev = None
 732
 733     name = mxl_event.get_name()
 734     func = spanner_event_dict.get (name)
 735     if func:
 736         ev = func()
 737     else:
 738         error_message ('unknown span event %s' % mxl_event)
 739
 740
 741     type = mxl_event.get_type ()
 742     span_direction = spanner_type_dict.get (type)
 743     # really check for None, because some types will be translated to 0, which
 744     # would otherwise also lead to the unknown span warning
 745     if span_direction != None:
 746         ev.span_direction = span_direction
 747     else:
 748         error_message ('unknown span type %s for %s' % (type, name))
 749
 750     ev.set_span_type (type)
 751     ev.line_type = getattr (mxl_event, 'line-type', 'solid')
 752
 753     # assign the size, which is used for octave-shift, etc.
 754     ev.size = mxl_event.get_size ()
 755
 756     return ev
 757
 758 def musicxml_direction_to_indicator (direction):
 759     return { "above": 1, "upright": 1, "up":1, "below": -1, "downright": -1, "down": -1 }.get (direction, 0)
 760
 761 def musicxml_fermata_to_lily_event (mxl_event):
 762     ev = musicexp.ArticulationEvent ()
 763     ev.type = "fermata"
 764     if hasattr (mxl_event, 'type'):
 765       dir = musicxml_direction_to_indicator (mxl_event.type)
 766       if dir and options.convert_directions:
 767         ev.force_direction = dir
 768     return ev
 769
 770 def musicxml_arpeggiate_to_lily_event (mxl_event):
 771     ev = musicexp.ArpeggioEvent ()
 772     ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
 773     return ev
 774
 775 def musicxml_tremolo_to_lily_event (mxl_event):
 776     ev = musicexp.TremoloEvent ()
 777     txt = mxl_event.get_text ()
 778     if txt:
 779         ev.bars = mxl_event.get_text ()
 780     else:
 781         ev.bars = "3"
 782     return ev
 783
 784 def musicxml_bend_to_lily_event (mxl_event):
 785     ev = musicexp.BendEvent ()
 786     ev.alter = mxl_event.bend_alter ()
 787     return ev
 788
 789 def musicxml_fingering_event (mxl_event):
 790     ev = musicexp.ShortArticulationEvent ()
 791     ev.type = mxl_event.get_text ()
 792     return ev
 793
 794 def musicxml_snappizzicato_event (mxl_event):
 795     needed_additional_definitions.append ("snappizzicato")
 796     ev = musicexp.MarkupEvent ()
 797     ev.contents = "\\snappizzicato"
 798     return ev
 799
 800 def musicxml_string_event (mxl_event):
 801     ev = musicexp.NoDirectionArticulationEvent ()
 802     ev.type = mxl_event.get_text ()
 803     return ev
 804
 805 def musicxml_accidental_mark (mxl_event):
 806     ev = musicexp.MarkupEvent ()
 807     contents = { "sharp": "\\sharp",
 808       "natural": "\\natural",
 809       "flat": "\\flat",
 810       "double-sharp": "\\doublesharp",
 811       "sharp-sharp": "\\sharp\\sharp",
 812       "flat-flat": "\\flat\\flat",
 813       "flat-flat": "\\doubleflat",
 814       "natural-sharp": "\\natural\\sharp",
 815       "natural-flat": "\\natural\\flat",
 816       "quarter-flat": "\\semiflat",
 817       "quarter-sharp": "\\semisharp",
 818       "three-quarters-flat": "\\sesquiflat",
 819       "three-quarters-sharp": "\\sesquisharp",
 820     }.get (mxl_event.get_text ())
 821     if contents:
 822         ev.contents = contents
 823         return ev
 824     else:
 825         return None
 826
 827 # translate articulations, ornaments and other notations into ArticulationEvents
 828 # possible values:
 829 #   -) string  (ArticulationEvent with that name)
 830 #   -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
 831 #   -) (class, name)  (like string, only that a different class than ArticulationEvent is used)
 832 # TODO: Some translations are missing!
 833 articulations_dict = {
 834     "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
 835     "accidental-mark": musicxml_accidental_mark,
 836     "bend": musicxml_bend_to_lily_event,
 837     "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
 838     #"caesura": "caesura",
 839     #"delayed-turn": "?",
 840     "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
 841     #"doit": "",
 842     #"double-tongue": "",
 843     "down-bow": "downbow",
 844     #"falloff": "",
 845     "fingering": musicxml_fingering_event,
 846     #"fingernails": "",
 847     #"fret": "",
 848     #"hammer-on": "",
 849     "harmonic": "flageolet",
 850     #"heel": "",
 851     "inverted-mordent": "prall",
 852     "inverted-turn": "reverseturn",
 853     "mordent": "mordent",
 854     "open-string": "open",
 855     #"plop": "",
 856     #"pluck": "",
 857     #"pull-off": "",
 858     #"schleifer": "?",
 859     #"scoop": "",
 860     #"shake": "?",
 861     "snap-pizzicato": musicxml_snappizzicato_event,
 862     #"spiccato": "",
 863     "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
 864     "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
 865     "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
 866     #"stress": "",
 867     "string": musicxml_string_event,
 868     "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
 869     #"tap": "",
 870     "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
 871     #"thumb-position": "",
 872     #"toe": "",
 873     "turn": "turn",
 874     "tremolo": musicxml_tremolo_to_lily_event,
 875     "trill-mark": "trill",
 876     #"triple-tongue": "",
 877     #"unstress": ""
 878     "up-bow": "upbow",
 879     #"wavy-line": "?",
 880 }
 881 articulation_spanners = [ "wavy-line" ]
 882
 883 def musicxml_articulation_to_lily_event (mxl_event):
 884     # wavy-line elements are treated as trill spanners, not as articulation ornaments
 885     if mxl_event.get_name () in articulation_spanners:
 886         return musicxml_spanner_to_lily_event (mxl_event)
 887
 888     tmp_tp = articulations_dict.get (mxl_event.get_name ())
 889     if not tmp_tp:
 890         return
 891
 892     if isinstance (tmp_tp, str):
 893         ev = musicexp.ArticulationEvent ()
 894         ev.type = tmp_tp
 895     elif isinstance (tmp_tp, tuple):
 896         ev = tmp_tp[0] ()
 897         ev.type = tmp_tp[1]
 898     else:
 899         ev = tmp_tp (mxl_event)
 900
 901     # Some articulations use the type attribute, other the placement...
 902     dir = None
 903     if hasattr (mxl_event, 'type') and options.convert_directions:
 904         dir = musicxml_direction_to_indicator (mxl_event.type)
 905     if hasattr (mxl_event, 'placement') and options.convert_directions:
 906         dir = musicxml_direction_to_indicator (mxl_event.placement)
 907     if dir:
 908         ev.force_direction = dir
 909     return ev
 910
 911
 912 def musicxml_dynamics_to_lily_event (dynentry):
 913     dynamics_available = ( "p", "pp", "ppp", "pppp", "ppppp", "pppppp",
 914         "f", "ff", "fff", "ffff", "fffff", "ffffff",
 915         "mp", "mf", "sf", "sfp", "sfpp", "fp",
 916         "rf", "rfz", "sfz", "sffz", "fz" )
 917     if not dynentry.get_name() in dynamics_available:
 918         return
 919     event = musicexp.DynamicsEvent ()
 920     event.type = dynentry.get_name ()
 921     return event
 922
 923 # Convert single-color two-byte strings to numbers 0.0 - 1.0
 924 def hexcolorval_to_nr (hex_val):
 925     try:
 926         v = int (hex_val, 16)
 927         if v == 255:
 928             v = 256
 929         return v / 256.
 930     except ValueError:
 931         return 0.
 932
 933 def hex_to_color (hex_val):
 934     res = re.match (r'#([0-9a-f][0-9a-f]|)([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])([0-9a-f][0-9a-f])$', hex_val, re.IGNORECASE)
 935     if res:
 936         return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
 937     else:
 938         return None
 939
 940 def musicxml_words_to_lily_event (words):
 941     event = musicexp.TextEvent ()
 942     text = words.get_text ()
 943     text = re.sub ('^ *\n? *', '', text)
 944     text = re.sub (' *\n? *$', '', text)
 945     event.text = text
 946
 947     if hasattr (words, 'default-y') and options.convert_directions:
 948         offset = getattr (words, 'default-y')
 949         try:
 950             off = string.atoi (offset)
 951             if off > 0:
 952                 event.force_direction = 1
 953             else:
 954                 event.force_direction = -1
 955         except ValueError:
 956             event.force_direction = 0
 957
 958     if hasattr (words, 'font-weight'):
 959         font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
 960         if font_weight:
 961             event.markup += font_weight
 962
 963     if hasattr (words, 'font-size'):
 964         size = getattr (words, 'font-size')
 965         font_size = {
 966             "xx-small": '\\teeny',
 967             "x-small": '\\tiny',
 968             "small": '\\small',
 969             "medium": '',
 970             "large": '\\large',
 971             "x-large": '\\huge',
 972             "xx-large": '\\bigger\\huge'
 973         }.get (size, '')
 974         if font_size:
 975             event.markup += font_size
 976
 977     if hasattr (words, 'color'):
 978         color = getattr (words, 'color')
 979         rgb = hex_to_color (color)
 980         if rgb:
 981             event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
 982
 983     if hasattr (words, 'font-style'):
 984         font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
 985         if font_style:
 986             event.markup += font_style
 987
 988     # TODO: How should I best convert the font-family attribute?
 989
 990     # TODO: How can I represent the underline, overline and line-through
 991     #       attributes in Lilypond? Values of these attributes indicate
 992     #       the number of lines
 993
 994     return event
 995
 996
 997 direction_spanners = [ 'octave-shift', 'pedal', 'wedge' ]
 998
 999 def musicxml_direction_to_lily (n):
1000     # TODO: Handle the <staff> element!
1001     res = []
1002     dirtype_children = []
1003     for dt in n.get_typed_children (musicxml.DirType):
1004         dirtype_children += dt.get_all_children ()
1005
1006     for entry in dirtype_children:
1007
1008         if entry.get_name () == "dynamics":
1009             for dynentry in entry.get_all_children ():
1010                 ev = musicxml_dynamics_to_lily_event (dynentry)
1011                 if ev:
1012                     res.append (ev)
1013
1014         if entry.get_name () == "words":
1015             ev = musicxml_words_to_lily_event (entry)
1016             if ev:
1017                 res.append (ev)
1018
1019         # octave shifts. pedal marks, hairpins etc. are spanners:
1020         if entry.get_name() in direction_spanners:
1021             event = musicxml_spanner_to_lily_event (entry)
1022             if event:
1023                 res.append (event)
1024
1025
1026     return res
1027
1028 def musicxml_frame_to_lily_event (frame):
1029     ev = musicexp.FretEvent ()
1030     ev.strings = frame.get_strings ()
1031     ev.frets = frame.get_frets ()
1032     #offset = frame.get_first_fret () - 1
1033     barre = []
1034     for fn in frame.get_named_children ('frame-note'):
1035         fret = fn.get_fret ()
1036         if fret <= 0:
1037             fret = "o"
1038         el = [ fn.get_string (), fret ]
1039         fingering = fn.get_fingering ()
1040         if fingering >= 0:
1041             el.append (fingering)
1042         ev.elements.append (el)
1043         b = fn.get_barre ()
1044         if b == 'start':
1045             barre[0] = el[0] # start string
1046             barre[2] = el[1] # fret
1047         elif b == 'stop':
1048             barre[1] = el[0] # end string
1049     if barre:
1050         ev.barre = barre
1051     return ev
1052
1053 def musicxml_harmony_to_lily (n):
1054     res = []
1055     for f in n.get_named_children ('frame'):
1056         ev = musicxml_frame_to_lily_event (f)
1057         if ev:
1058             res.append (ev)
1059
1060     return res
1061
1062 instrument_drumtype_dict = {
1063     'Acoustic Snare Drum': 'acousticsnare',
1064     'Side Stick': 'sidestick',
1065     'Open Triangle': 'opentriangle',
1066     'Mute Triangle': 'mutetriangle',
1067     'Tambourine': 'tambourine',
1068     'Bass Drum': 'bassdrum',
1069 }
1070
1071 def musicxml_note_to_lily_main_event (n):
1072     pitch  = None
1073     duration = None
1074     event = None
1075
1076     mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1077     if mxl_pitch:
1078         pitch = musicxml_pitch_to_lily (mxl_pitch)
1079         event = musicexp.NoteEvent ()
1080         event.pitch = pitch
1081
1082         acc = n.get_maybe_exist_named_child ('accidental')
1083         if acc:
1084             # let's not force accs everywhere.
1085             event.cautionary = acc.editorial
1086
1087     elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1088         # Unpitched elements have display-step and can also have
1089         # display-octave.
1090         unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1091         event = musicexp.NoteEvent ()
1092         event.pitch = musicxml_unpitched_to_lily (unpitched)
1093
1094     elif n.get_maybe_exist_typed_child (musicxml.Rest):
1095         # rests can have display-octave and display-step, which are
1096         # treated like an ordinary note pitch
1097         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1098         event = musicexp.RestEvent ()
1099         pitch = musicxml_restdisplay_to_lily (rest)
1100         event.pitch = pitch
1101
1102     elif n.instrument_name:
1103         event = musicexp.NoteEvent ()
1104         drum_type = instrument_drumtype_dict.get (n.instrument_name)
1105         if drum_type:
1106             event.drum_type = drum_type
1107         else:
1108             n.message ("drum %s type unknown, please add to instrument_drumtype_dict" % n.instrument_name)
1109             event.drum_type = 'acousticsnare'
1110
1111     else:
1112         n.message ("cannot find suitable event")
1113
1114     if event:
1115         event.duration = musicxml_duration_to_lily (n)
1116
1117     return event
1118
1119
1120 ## TODO
1121 class NegativeSkip:
1122     def __init__ (self, here, dest):
1123         self.here = here
1124         self.dest = dest
1125
1126 class LilyPondVoiceBuilder:
1127     def __init__ (self):
1128         self.elements = []
1129         self.pending_dynamics = []
1130         self.end_moment = Rational (0)
1131         self.begin_moment = Rational (0)
1132         self.pending_multibar = Rational (0)
1133         self.ignore_skips = False
1134
1135     def _insert_multibar (self):
1136         r = musicexp.MultiMeasureRest ()
1137         r.duration = musicexp.Duration()
1138         r.duration.duration_log = 0
1139         r.duration.factor = self.pending_multibar
1140         self.elements.append (r)
1141         self.begin_moment = self.end_moment
1142         self.end_moment = self.begin_moment + self.pending_multibar
1143         self.pending_multibar = Rational (0)
1144
1145     def add_multibar_rest (self, duration):
1146         self.pending_multibar += duration
1147
1148     def set_duration (self, duration):
1149         self.end_moment = self.begin_moment + duration
1150     def current_duration (self):
1151         return self.end_moment - self.begin_moment
1152
1153     def add_music (self, music, duration):
1154         assert isinstance (music, musicexp.Music)
1155         if self.pending_multibar > Rational (0):
1156             self._insert_multibar ()
1157
1158         self.elements.append (music)
1159         self.begin_moment = self.end_moment
1160         self.set_duration (duration)
1161
1162         # Insert all pending dynamics right after the note/rest:
1163         if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1164             for d in self.pending_dynamics:
1165                 music.append (d)
1166             self.pending_dynamics = []
1167
1168     # Insert some music command that does not affect the position in the measure
1169     def add_command (self, command):
1170         assert isinstance (command, musicexp.Music)
1171         if self.pending_multibar > Rational (0):
1172             self._insert_multibar ()
1173         self.elements.append (command)
1174     def add_barline (self, barline):
1175         # TODO: Implement merging of default barline and custom bar line
1176         self.add_music (barline, Rational (0))
1177     def add_partial (self, command):
1178         self.ignore_skips = True
1179         self.add_command (command)
1180
1181     def add_dynamics (self, dynamic):
1182         # store the dynamic item(s) until we encounter the next note/rest:
1183         self.pending_dynamics.append (dynamic)
1184
1185     def add_bar_check (self, number):
1186         b = musicexp.BarLine ()
1187         b.bar_number = number
1188         self.add_barline (b)
1189
1190     def jumpto (self, moment):
1191         current_end = self.end_moment + self.pending_multibar
1192         diff = moment - current_end
1193
1194         if diff < Rational (0):
1195             error_message ('Negative skip %s' % diff)
1196             diff = Rational (0)
1197
1198         if diff > Rational (0) and not (self.ignore_skips and moment == 0):
1199             skip = musicexp.SkipEvent()
1200             duration_factor = 1
1201             duration_log = {1: 0, 2: 1, 4:2, 8:3, 16:4, 32:5, 64:6, 128:7, 256:8, 512:9}.get (diff.denominator (), -1)
1202             duration_dots = 0
1203             if duration_log > 0: # denominator is a power of 2...
1204                 if diff.numerator () == 3:
1205                     duration_log -= 1
1206                     duration_dots = 1
1207                 else:
1208                     duration_factor = Rational (diff.numerator ())
1209             else:
1210                 duration_log = 0
1211                 duration_factor = diff
1212             skip.duration.duration_log = duration_log
1213             skip.duration.factor = duration_factor
1214             skip.duration.dots = duration_dots
1215
1216             evc = musicexp.ChordEvent ()
1217             evc.elements.append (skip)
1218             self.add_music (evc, diff)
1219
1220         if diff > Rational (0) and moment == 0:
1221             self.ignore_skips = False
1222
1223     def last_event_chord (self, starting_at):
1224
1225         value = None
1226
1227         # if the position matches, find the last ChordEvent, do not cross a bar line!
1228         at = len( self.elements ) - 1
1229         while (at >= 0 and
1230                not isinstance (self.elements[at], musicexp.ChordEvent) and
1231                not isinstance (self.elements[at], musicexp.BarLine)):
1232             at -= 1
1233
1234         if (self.elements
1235             and at >= 0
1236             and isinstance (self.elements[at], musicexp.ChordEvent)
1237             and self.begin_moment == starting_at):
1238             value = self.elements[at]
1239         else:
1240             self.jumpto (starting_at)
1241             value = None
1242         return value
1243
1244     def correct_negative_skip (self, goto):
1245         self.end_moment = goto
1246         self.begin_moment = goto
1247         evc = musicexp.ChordEvent ()
1248         self.elements.append (evc)
1249
1250
1251 class VoiceData:
1252     def __init__ (self):
1253         self.voicedata = None
1254         self.ly_voice = None
1255         self.lyrics_dict = {}
1256         self.lyrics_order = []
1257
1258 def musicxml_step_to_lily (step):
1259     if step:
1260         return (ord (step) - ord ('A') + 7 - 2) % 7
1261     else:
1262         return None
1263
1264 def musicxml_voice_to_lily_voice (voice):
1265     tuplet_events = []
1266     modes_found = {}
1267     lyrics = {}
1268     return_value = VoiceData ()
1269     return_value.voicedata = voice
1270
1271     # First pitch needed for relative mode (if selected in command-line options)
1272     first_pitch = None
1273
1274     # Needed for melismata detection (ignore lyrics on those notes!):
1275     inside_slur = False
1276     is_tied = False
1277     is_chord = False
1278     ignore_lyrics = False
1279
1280     current_staff = None
1281
1282     # Make sure that the keys in the dict don't get reordered, since
1283     # we need the correct ordering of the lyrics stanzas! By default,
1284     # a dict will reorder its keys
1285     return_value.lyrics_order = voice.get_lyrics_numbers ()
1286     for k in return_value.lyrics_order:
1287         lyrics[k] = []
1288
1289     voice_builder = LilyPondVoiceBuilder()
1290
1291     for n in voice._elements:
1292         if n.get_name () == 'forward':
1293             continue
1294         staff = n.get_maybe_exist_named_child ('staff')
1295         if staff:
1296             staff = staff.get_text ()
1297             if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
1298                 voice_builder.add_command (musicexp.StaffChange (staff))
1299             current_staff = staff
1300
1301         if isinstance (n, musicxml.Partial) and n.partial > 0:
1302             a = musicxml_partial_to_lily (n.partial)
1303             if a:
1304                 voice_builder.add_partial (a)
1305             continue
1306
1307         if isinstance (n, musicxml.Direction):
1308             for a in musicxml_direction_to_lily (n):
1309                 if a.wait_for_note ():
1310                     voice_builder.add_dynamics (a)
1311                 else:
1312                     voice_builder.add_command (a)
1313             continue
1314
1315         if isinstance (n, musicxml.Harmony):
1316             for a in musicxml_harmony_to_lily (n):
1317                 if a.wait_for_note ():
1318                     voice_builder.add_dynamics (a)
1319                 else:
1320                     voice_builder.add_command (a)
1321             continue
1322
1323         is_chord = n.get_maybe_exist_named_child ('chord')
1324         if not is_chord:
1325             try:
1326                 voice_builder.jumpto (n._when)
1327             except NegativeSkip, neg:
1328                 voice_builder.correct_negative_skip (n._when)
1329                 n.message ("Negative skip? from %s to %s, diff %s" % (neg.here, neg.dest, neg.dest - neg.here))
1330
1331         if isinstance (n, musicxml.Attributes):
1332             if n.is_first () and n._measure_position == Rational (0):
1333                 try:
1334                     number = int (n.get_parent ().number)
1335                 except ValueError:
1336                     number = 0
1337                 if number > 0:
1338                     voice_builder.add_bar_check (number)
1339
1340             for a in musicxml_attributes_to_lily (n):
1341                 voice_builder.add_command (a)
1342             continue
1343
1344         if isinstance (n, musicxml.Barline):
1345             barlines = musicxml_barline_to_lily (n)
1346             for a in barlines:
1347                 if isinstance (a, musicexp.BarLine):
1348                     voice_builder.add_barline (a)
1349                 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
1350                     voice_builder.add_command (a)
1351             continue
1352
1353         if not n.__class__.__name__ == 'Note':
1354             error_message ('not a Note or Attributes? %s' % n)
1355             continue
1356
1357         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1358         if (rest
1359             and rest.is_whole_measure ()):
1360
1361             voice_builder.add_multibar_rest (n._duration)
1362             continue
1363
1364         if n.is_first () and n._measure_position == Rational (0):
1365             try:
1366                 num = int (n.get_parent ().number)
1367             except ValueError:
1368                 num = 0
1369             if num > 0:
1370                 voice_builder.add_bar_check (num)
1371
1372         main_event = musicxml_note_to_lily_main_event (n)
1373         if main_event and not first_pitch:
1374             first_pitch = main_event.pitch
1375         ignore_lyrics = inside_slur or is_tied or is_chord
1376
1377         if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
1378             modes_found['drummode'] = True
1379
1380         ev_chord = voice_builder.last_event_chord (n._when)
1381         if not ev_chord:
1382             ev_chord = musicexp.ChordEvent()
1383             voice_builder.add_music (ev_chord, n._duration)
1384
1385         grace = n.get_maybe_exist_typed_child (musicxml.Grace)
1386         if grace:
1387             grace_chord = None
1388             if n.get_maybe_exist_typed_child (musicxml.Chord) and ev_chord.grace_elements:
1389                 grace_chord = ev_chord.grace_elements.get_last_event_chord ()
1390             if not grace_chord:
1391                 grace_chord = musicexp.ChordEvent ()
1392                 ev_chord.append_grace (grace_chord)
1393             if hasattr (grace, 'slash'):
1394                 # TODO: use grace_type = "appoggiatura" for slurred grace notes
1395                 if grace.slash == "yes":
1396                     ev_chord.grace_type = "acciaccatura"
1397             # now that we have inserted the chord into the grace music, insert
1398             # everything into that chord instead of the ev_chord
1399             ev_chord = grace_chord
1400             ev_chord.append (main_event)
1401             ignore_lyrics = True
1402         else:
1403             ev_chord.append (main_event)
1404             # When a note/chord has grace notes (duration==0), the duration of the
1405             # event chord is not yet known, but the event chord was already added
1406             # with duration 0. The following correct this when we hit the real note!
1407             if voice_builder.current_duration () == 0 and n._duration > 0:
1408                 voice_builder.set_duration (n._duration)
1409
1410         notations_children = n.get_typed_children (musicxml.Notations)
1411         tuplet_event = None
1412         span_events = []
1413
1414         # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
1415         # +tied | +slur | +tuplet | glissando | slide |
1416         #    ornaments | technical | articulations | dynamics |
1417         #    +fermata | arpeggiate | non-arpeggiate |
1418         #    accidental-mark | other-notation
1419         for notations in notations_children:
1420             for tuplet_event in notations.get_tuplets():
1421                 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1422                 frac = (1,1)
1423                 if mod:
1424                     frac = mod.get_fraction ()
1425
1426                 tuplet_events.append ((ev_chord, tuplet_event, frac))
1427
1428             slurs = [s for s in notations.get_named_children ('slur')
1429                 if s.get_type () in ('start','stop')]
1430             if slurs:
1431                 if len (slurs) > 1:
1432                     error_message ('more than 1 slur?')
1433                 # record the slur status for the next note in the loop
1434                 if not grace:
1435                     if slurs[0].get_type () == 'start':
1436                         inside_slur = True
1437                     elif slurs[0].get_type () == 'stop':
1438                         inside_slur = False
1439                 lily_ev = musicxml_spanner_to_lily_event (slurs[0])
1440                 ev_chord.append (lily_ev)
1441
1442             if not grace:
1443                 mxl_tie = notations.get_tie ()
1444                 if mxl_tie and mxl_tie.type == 'start':
1445                     ev_chord.append (musicexp.TieEvent ())
1446                     is_tied = True
1447                 else:
1448                     is_tied = False
1449
1450             fermatas = notations.get_named_children ('fermata')
1451             for a in fermatas:
1452                 ev = musicxml_fermata_to_lily_event (a)
1453                 if ev:
1454                     ev_chord.append (ev)
1455
1456             arpeggiate = notations.get_named_children ('arpeggiate')
1457             for a in arpeggiate:
1458                 ev = musicxml_arpeggiate_to_lily_event (a)
1459                 if ev:
1460                     ev_chord.append (ev)
1461
1462             glissandos = notations.get_named_children ('glissando')
1463             for a in glissandos:
1464                 ev = musicxml_spanner_to_lily_event (a)
1465                 if ev:
1466                     ev_chord.append (ev)
1467
1468             # Articulations can contain the following child elements:
1469             #         accent | strong-accent | staccato | tenuto |
1470             #         detached-legato | staccatissimo | spiccato |
1471             #         scoop | plop | doit | falloff | breath-mark |
1472             #         caesura | stress | unstress
1473             # Technical can contain the following child elements:
1474             #         up-bow | down-bow | harmonic | open-string |
1475             #         thumb-position | fingering | pluck | double-tongue |
1476             #         triple-tongue | stopped | snap-pizzicato | fret |
1477             #         string | hammer-on | pull-off | bend | tap | heel |
1478             #         toe | fingernails | other-technical
1479             # Ornaments can contain the following child elements:
1480             #         trill-mark | turn | delayed-turn | inverted-turn |
1481             #         shake | wavy-line | mordent | inverted-mordent |
1482             #         schleifer | tremolo | other-ornament, accidental-mark
1483             ornaments = notations.get_named_children ('ornaments')
1484             ornaments += notations.get_named_children ('articulations')
1485             ornaments += notations.get_named_children ('technical')
1486
1487             for a in ornaments:
1488                 for ch in a.get_all_children ():
1489                     ev = musicxml_articulation_to_lily_event (ch)
1490                     if ev:
1491                         ev_chord.append (ev)
1492
1493             dynamics = notations.get_named_children ('dynamics')
1494             for a in dynamics:
1495                 for ch in a.get_all_children ():
1496                     ev = musicxml_dynamics_to_lily_event (ch)
1497                     if ev:
1498                         ev_chord.append (ev)
1499
1500         # Extract the lyrics
1501         if not rest and not ignore_lyrics:
1502             note_lyrics_processed = []
1503             note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
1504             for l in note_lyrics_elements:
1505                 if l.get_number () < 0:
1506                     for k in lyrics.keys ():
1507                         lyrics[k].append (l.lyric_to_text ())
1508                         note_lyrics_processed.append (k)
1509                 else:
1510                     lyrics[l.number].append(l.lyric_to_text ())
1511                     note_lyrics_processed.append (l.number)
1512             for lnr in lyrics.keys ():
1513                 if not lnr in note_lyrics_processed:
1514                     lyrics[lnr].append ("\skip4")
1515
1516
1517         mxl_beams = [b for b in n.get_named_children ('beam')
1518                      if (b.get_type () in ('begin', 'end')
1519                          and b.is_primary ())]
1520         if mxl_beams:
1521             beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
1522             if beam_ev:
1523                 ev_chord.append (beam_ev)
1524
1525         if tuplet_event:
1526             mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1527             frac = (1,1)
1528             if mod:
1529                 frac = mod.get_fraction ()
1530
1531             tuplet_events.append ((ev_chord, tuplet_event, frac))
1532
1533     ## force trailing mm rests to be written out.
1534     voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
1535
1536     ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
1537     ly_voice = group_repeats (ly_voice)
1538
1539     seq_music = musicexp.SequentialMusic ()
1540
1541     if 'drummode' in modes_found.keys ():
1542         ## \key <pitch> barfs in drummode.
1543         ly_voice = [e for e in ly_voice
1544                     if not isinstance(e, musicexp.KeySignatureChange)]
1545
1546     seq_music.elements = ly_voice
1547     for k in lyrics.keys ():
1548         return_value.lyrics_dict[k] = musicexp.Lyrics ()
1549         return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
1550
1551
1552     if len (modes_found) > 1:
1553        error_message ('Too many modes found %s' % modes_found.keys ())
1554
1555     if options.relative:
1556         v = musicexp.RelativeMusic ()
1557         v.element = seq_music
1558         v.basepitch = first_pitch
1559         seq_music = v
1560
1561     return_value.ly_voice = seq_music
1562     for mode in modes_found.keys ():
1563         v = musicexp.ModeChangingMusicWrapper()
1564         v.element = seq_music
1565         v.mode = mode
1566         return_value.ly_voice = v
1567
1568     return return_value
1569
1570 def musicxml_id_to_lily (id):
1571     digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
1572               'Six', 'Seven', 'Eight', 'Nine', 'Ten']
1573
1574     for digit in digits:
1575         d = digits.index (digit)
1576         id = re.sub ('%d' % d, digit, id)
1577
1578     id = re.sub  ('[^a-zA-Z]', 'X', id)
1579     return id
1580
1581 def musicxml_pitch_to_lily (mxl_pitch):
1582     p = musicexp.Pitch ()
1583     p.alteration = mxl_pitch.get_alteration ()
1584     p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
1585     p.octave = mxl_pitch.get_octave () - 4
1586     return p
1587
1588 def musicxml_unpitched_to_lily (mxl_unpitched):
1589     p = None
1590     step = mxl_unpitched.get_step ()
1591     if step:
1592         p = musicexp.Pitch ()
1593         p.step = musicxml_step_to_lily (step)
1594     octave = mxl_unpitched.get_octave ()
1595     if octave and p:
1596         p.octave = octave - 4
1597     return p
1598
1599 def musicxml_restdisplay_to_lily (mxl_rest):
1600     p = None
1601     step = mxl_rest.get_step ()
1602     if step:
1603         p = musicexp.Pitch ()
1604         p.step = musicxml_step_to_lily (step)
1605     octave = mxl_rest.get_octave ()
1606     if octave and p:
1607         p.octave = octave - 4
1608     return p
1609
1610 def voices_in_part (part):
1611     """Return a Name -> Voice dictionary for PART"""
1612     part.interpret ()
1613     part.extract_voices ()
1614     voices = part.get_voices ()
1615     part_info = part.get_staff_attributes ()
1616
1617     return (voices, part_info)
1618
1619 def voices_in_part_in_parts (parts):
1620     """return a Part -> Name -> Voice dictionary"""
1621     return dict([(p.id, voices_in_part (p)) for p in parts])
1622
1623
1624 def get_all_voices (parts):
1625     all_voices = voices_in_part_in_parts (parts)
1626
1627     all_ly_voices = {}
1628     all_ly_staffinfo = {}
1629     for p, (name_voice, staff_info) in all_voices.items ():
1630
1631         part_ly_voices = {}
1632         for n, v in name_voice.items ():
1633             progress ("Converting to LilyPond expressions...")
1634             # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
1635             part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
1636
1637         all_ly_voices[p] = part_ly_voices
1638         all_ly_staffinfo[p] = staff_info
1639
1640     return (all_ly_voices, all_ly_staffinfo)
1641
1642
1643 def option_parser ():
1644     p = ly.get_option_parser(usage=_ ("musicxml2ly [options] FILE.xml"),
1645                              version=('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
1646                                       +
1647 _ ("""This program is free software.  It is covered by the GNU General Public
1648 License and you are welcome to change it and/or distribute copies of it
1649 under certain conditions.  Invoke as `%s --warranty' for more
1650 information.""") % 'lilypond'
1651 + """
1652 Copyright (c) 2005--2007 by
1653     Han-Wen Nienhuys <hanwen@xs4all.nl>,
1654     Jan Nieuwenhuizen <janneke@gnu.org> and
1655     Reinhold Kainhofer <reinhold@kainhofer.com>
1656 """),
1657                              description=_ ("Convert %s to LilyPond input.") % 'MusicXML' + "\n")
1658     p.add_option ('-v', '--verbose',
1659                   action="store_true",
1660                   dest='verbose',
1661                   help=_ ("be verbose"))
1662
1663     p.add_option ('', '--lxml',
1664                   action="store_true",
1665                   default=False,
1666                   dest="use_lxml",
1667                   help=_ ("Use lxml.etree; uses less memory and cpu time."))
1668
1669     p.add_option ('-z', '--compressed',
1670                   action = "store_true",
1671                   dest = 'compressed',
1672                   default = False,
1673                   help = _ ("Input file is a zip-compressed MusicXML file."))
1674
1675     p.add_option ('-r', '--relative',
1676                   action = "store_true",
1677                   dest = "relative",
1678                   help = _ ("Convert pitches in relative mode."))
1679
1680     p.add_option ('-l', '--language',
1681                   action = "store",
1682                   help = _ ("Use a different language file, e.g. 'deutsch' for deutsch.ly."))
1683
1684     p.add_option ('--no-articulation-directions', '--nd',
1685                   action = "store_false",
1686                   default = True,
1687                   dest = "convert_directions",
1688                   help = _ ("Do not convert directions (^, _ or -) for articulations."))
1689
1690     p.add_option ('-o', '--output',
1691                   metavar=_ ("FILE"),
1692                   action="store",
1693                   default=None,
1694                   type='string',
1695                   dest='output_name',
1696                   help=_ ("set output filename to FILE"))
1697     p.add_option_group ('bugs',
1698                         description=(_ ("Report bugs via")
1699                                      + ''' http://post.gmane.org/post.php'''
1700                                      '''?group=gmane.comp.gnu.lilypond.bugs\n'''))
1701     return p
1702
1703 def music_xml_voice_name_to_lily_name (part_id, name):
1704     str = "Part%sVoice%s" % (part_id, name)
1705     return musicxml_id_to_lily (str)
1706
1707 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
1708     str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
1709     return musicxml_id_to_lily (str)
1710
1711 def print_voice_definitions (printer, part_list, voices):
1712     for part in part_list:
1713         part_id = part.id
1714         nv_dict = voices.get (part_id, {})
1715         for (name, voice) in nv_dict.items ():
1716             k = music_xml_voice_name_to_lily_name (part_id, name)
1717             printer.dump ('%s = ' % k)
1718             voice.ly_voice.print_ly (printer)
1719             printer.newline()
1720             for l in voice.lyrics_order:
1721                 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
1722                 printer.dump ('%s = ' %lname )
1723                 voice.lyrics_dict[l].print_ly (printer)
1724                 printer.newline()
1725
1726
1727 def uniq_list (l):
1728     return dict ([(elt,1) for elt in l]).keys ()
1729
1730 # format the information about the staff in the form
1731 #     [staffid,
1732 #         [
1733 #            [voiceid1, [lyricsid11, lyricsid12,...] ...],
1734 #            [voiceid2, [lyricsid21, lyricsid22,...] ...],
1735 #            ...
1736 #         ]
1737 #     ]
1738 # raw_voices is of the form [(voicename, lyricsids)*]
1739 def format_staff_info (part_id, staff_id, raw_voices):
1740     voices = []
1741     for (v, lyricsids) in raw_voices:
1742         voice_name = music_xml_voice_name_to_lily_name (part_id, v)
1743         voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
1744                    for l in lyricsids]
1745         voices.append ([voice_name, voice_lyrics])
1746     return [staff_id, voices]
1747
1748 def update_score_setup (score_structure, part_list, voices):
1749
1750     for part_definition in part_list:
1751         part_id = part_definition.id
1752         nv_dict = voices.get (part_id)
1753         if not nv_dict:
1754             error_message ('unknown part in part-list: %s' % part_id)
1755             continue
1756
1757         staves = reduce (lambda x,y: x+ y,
1758                 [voice.voicedata._staves.keys ()
1759                  for voice in nv_dict.values ()],
1760                 [])
1761         staves_info = []
1762         if len (staves) > 1:
1763             staves_info = []
1764             staves = uniq_list (staves)
1765             staves.sort ()
1766             for s in staves:
1767                 thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1768                     for (voice_name, voice) in nv_dict.items ()
1769                     if voice.voicedata._start_staff == s]
1770                 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
1771         else:
1772             thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1773                 for (voice_name, voice) in nv_dict.items ()]
1774             staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
1775         score_structure.set_part_information (part_id, staves_info)
1776
1777 def print_ly_preamble (printer, filename):
1778     printer.dump_version ()
1779     printer.print_verbatim ('%% automatically converted from %s\n' % filename)
1780
1781 def print_ly_additional_definitions (printer, filename):
1782     if needed_additional_definitions:
1783         printer.newline ()
1784         printer.print_verbatim ('%% additional definitions required by the score:')
1785         printer.newline ()
1786     for a in set(needed_additional_definitions):
1787         printer.print_verbatim (additional_definitions.get (a, ''))
1788     printer.newline ()
1789
1790 # Read in the tree from the given I/O object (either file or string) and
1791 # demarshall it using the classes from the musicxml.py file
1792 def read_xml (io_object, use_lxml):
1793     if use_lxml:
1794         import lxml.etree
1795         tree = lxml.etree.parse (io_object)
1796         mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
1797         return mxl_tree
1798     else:
1799         from xml.dom import minidom, Node
1800         doc = minidom.parse(io_object)
1801         node = doc.documentElement
1802         return musicxml.minidom_demarshal_node (node)
1803     return None
1804
1805
1806 def read_musicxml (filename, compressed, use_lxml):
1807     raw_string = None
1808     if compressed:
1809         progress ("Input file %s is compressed, extracting raw MusicXML data" % filename)
1810         z = zipfile.ZipFile (filename, "r")
1811         container_xml = z.read ("META-INF/container.xml")
1812         if not container_xml:
1813             return None
1814         container = read_xml (StringIO.StringIO (container_xml), use_lxml)
1815         if not container:
1816             return None
1817         rootfiles = container.get_maybe_exist_named_child ('rootfiles')
1818         if not rootfiles:
1819             return None
1820         rootfile_list = rootfiles.get_named_children ('rootfile')
1821         mxml_file = None
1822         if len (rootfile_list) > 0:
1823             mxml_file = getattr (rootfile_list[0], 'full-path', None)
1824         if mxml_file:
1825             raw_string = z.read (mxml_file)
1826
1827     io_object = filename
1828     if raw_string:
1829         io_object = StringIO.StringIO (raw_string)
1830
1831     return read_xml (io_object, use_lxml)
1832
1833
1834 def convert (filename, options):
1835     progress ("Reading MusicXML from %s ..." % filename)
1836
1837     tree = read_musicxml (filename, options.compressed, options.use_lxml)
1838     parts = tree.get_typed_children (musicxml.Part)
1839     (voices, staff_info) = get_all_voices (parts)
1840
1841     score_structure = None
1842     mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
1843     if mxl_pl:
1844         score_structure = extract_score_layout (mxl_pl, staff_info)
1845         part_list = mxl_pl.get_named_children ("score-part")
1846
1847     # score information is contained in the <work>, <identification> or <movement-title> tags
1848     score_information = extract_score_information (tree)
1849     layout_information = extract_layout_information (tree)
1850     update_score_setup (score_structure, part_list, voices)
1851
1852     if not options.output_name:
1853         options.output_name = os.path.basename (filename)
1854         options.output_name = os.path.splitext (options.output_name)[0]
1855     elif re.match (".*\.ly", options.output_name):
1856         options.output_name = os.path.splitext (options.output_name)[0]
1857
1858
1859     defs_ly_name = options.output_name + '-defs.ly'
1860     driver_ly_name = options.output_name + '.ly'
1861
1862     printer = musicexp.Output_printer()
1863     progress ("Output to `%s'" % defs_ly_name)
1864     printer.set_file (codecs.open (defs_ly_name, 'wb', encoding='utf-8'))
1865
1866     print_ly_preamble (printer, filename)
1867     print_ly_additional_definitions (printer, filename)
1868     if score_information:
1869         score_information.print_ly (printer)
1870     if layout_information:
1871         layout_information.print_ly (printer)
1872     print_voice_definitions (printer, part_list, voices)
1873
1874     printer.close ()
1875
1876
1877     progress ("Output to `%s'" % driver_ly_name)
1878     printer = musicexp.Output_printer()
1879     printer.set_file (codecs.open (driver_ly_name, 'wb', encoding='utf-8'))
1880     print_ly_preamble (printer, filename)
1881     printer.dump (r'\include "%s"' % os.path.basename (defs_ly_name))
1882     score_structure.print_ly (printer)
1883     printer.newline ()
1884
1885     return voices
1886
1887 def get_existing_filename_with_extension (filename, ext):
1888     if os.path.exists (filename):
1889         return filename
1890     newfilename = filename + "." + ext
1891     if os.path.exists (newfilename):
1892         return newfilename;
1893     newfilename = filename + ext
1894     if os.path.exists (newfilename):
1895         return newfilename;
1896     return ''
1897
1898 def main ():
1899     opt_parser = option_parser()
1900
1901     global options
1902     (options, args) = opt_parser.parse_args ()
1903     if not args:
1904         opt_parser.print_usage()
1905         sys.exit (2)
1906
1907     if options.language:
1908         musicexp.set_pitch_language (options.language)
1909         needed_additional_definitions.append (options.language)
1910         additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
1911
1912     # Allow the user to leave out the .xml or xml on the filename
1913     filename = get_existing_filename_with_extension (args[0], "xml")
1914     if not filename:
1915         filename = get_existing_filename_with_extension (args[0], "mxl")
1916         options.compressed = True
1917     if filename and os.path.exists (filename):
1918         voices = convert (filename, options)
1919     else:
1920         progress ("Unable to find input file %s" % args[0])
1921
1922 if __name__ == '__main__':
1923     main()