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