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 def round_to_two_digits (val):
  56     return round (val * 100) / 100
  57
  58 def extract_layout_information (tree):
  59     paper = musicexp.Paper ()
  60     defaults = tree.get_maybe_exist_named_child ('defaults')
  61     if not defaults:
  62         return None
  63     tenths = -1
  64     scaling = defaults.get_maybe_exist_named_child ('scaling')
  65     if scaling:
  66         mm = scaling.get_named_child ('millimeters')
  67         mm = string.atof (mm.get_text ())
  68         tn = scaling.get_maybe_exist_named_child ('tenths')
  69         tn = string.atof (tn.get_text ())
  70         tenths = mm / tn
  71         paper.global_staff_size = mm * 72.27 / 25.4
  72     # We need the scaling (i.e. the size of staff tenths for everything!
  73     if tenths < 0:
  74         return None
  75
  76     def from_tenths (txt):
  77         return round_to_two_digits (string.atof (txt) * tenths / 10)
  78     def set_paper_variable (varname, parent, element_name):
  79         el = parent.get_maybe_exist_named_child (element_name)
  80         if el: # Convert to cm from tenths
  81             setattr (paper, varname, from_tenths (el.get_text ()))
  82
  83     pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
  84     if pagelayout:
  85         # TODO: How can one have different margins for even and odd pages???
  86         set_paper_variable ("page_height", pagelayout, 'page-height')
  87         set_paper_variable ("page_width", pagelayout, 'page-width')
  88
  89         pmargins = pagelayout.get_named_children ('page-margins')
  90         for pm in pmargins:
  91             set_paper_variable ("left_margin", pm, 'left-margin')
  92             set_paper_variable ("right_margin", pm, 'right-margin')
  93             set_paper_variable ("bottom_margin", pm, 'bottom-margin')
  94             set_paper_variable ("top_margin", pm, 'top-margin')
  95
  96     systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
  97     if systemlayout:
  98         sl = systemlayout.get_maybe_exist_named_child ('system-margins')
  99         if sl:
 100             set_paper_variable ("system_left_margin", sl, 'left-margin')
 101             set_paper_variable ("system_right_margin", sl, 'right-margin')
 102         set_paper_variable ("system_distance", systemlayout, 'system-distance')
 103         set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
 104
 105     stafflayout = defaults.get_named_children ('staff-layout')
 106     for sl in stafflayout:
 107         nr = getattr (sl, 'number', 1)
 108         dist = sl.get_named_child ('staff-distance')
 109         #TODO: the staff distance needs to be set in the Staff context!!!
 110
 111     # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
 112     appearance = defaults.get_named_child ('appearance')
 113     if appearance:
 114         lws = appearance.get_named_children ('line-width')
 115         for lw in lws:
 116             # Possible types are: beam, bracket, dashes,
 117             #    enclosure, ending, extend, heavy barline, leger,
 118             #    light barline, octave shift, pedal, slur middle, slur tip,
 119             #    staff, stem, tie middle, tie tip, tuplet bracket, and wedge
 120             tp = lw.type
 121             w = from_tenths (lw.get_text  ())
 122             # TODO: Do something with these values!
 123         nss = appearance.get_named_children ('note-size')
 124         for ns in nss:
 125             # Possible types are: cue, grace and large
 126             tp = ns.type
 127             sz = from_tenths (ns.get_text ())
 128             # TODO: Do something with these values!
 129         # <other-appearance> elements have no specified meaning
 130
 131     rawmusicfont = defaults.get_named_child ('music-font')
 132     if rawmusicfont:
 133         # TODO: Convert the font
 134         pass
 135     rawwordfont = defaults.get_named_child ('word-font')
 136     if rawwordfont:
 137         # TODO: Convert the font
 138         pass
 139     rawlyricsfonts = defaults.get_named_children ('lyric-font')
 140     for lyricsfont in rawlyricsfonts:
 141         # TODO: Convert the font
 142         pass
 143
 144     return paper
 145
 146
 147
 148 # score information is contained in the <work>, <identification> or <movement-title> tags
 149 # extract those into a hash, indexed by proper lilypond header attributes
 150 def extract_score_information (tree):
 151     header = musicexp.Header ()
 152     def set_if_exists (field, value):
 153         if value:
 154             header.set_field (field, musicxml.escape_ly_output_string (value))
 155
 156     work = tree.get_maybe_exist_named_child ('work')
 157     if work:
 158         set_if_exists ('title', work.get_work_title ())
 159         set_if_exists ('worknumber', work.get_work_number ())
 160         set_if_exists ('opus', work.get_opus ())
 161     else:
 162         movement_title = tree.get_maybe_exist_named_child ('movement-title')
 163         if movement_title:
 164             set_if_exists ('title', movement_title.get_text ())
 165
 166     identifications = tree.get_named_children ('identification')
 167     for ids in identifications:
 168         set_if_exists ('copyright', ids.get_rights ())
 169         set_if_exists ('composer', ids.get_composer ())
 170         set_if_exists ('arranger', ids.get_arranger ())
 171         set_if_exists ('editor', ids.get_editor ())
 172         set_if_exists ('poet', ids.get_poet ())
 173
 174         set_if_exists ('tagline', ids.get_encoding_software ())
 175         set_if_exists ('encodingsoftware', ids.get_encoding_software ())
 176         set_if_exists ('encodingdate', ids.get_encoding_date ())
 177         set_if_exists ('encoder', ids.get_encoding_person ())
 178         set_if_exists ('encodingdescription', ids.get_encoding_description ())
 179
 180     return header
 181
 182 class PartGroupInfo:
 183     def __init__ (self):
 184         self.start = {}
 185         self.end = {}
 186     def is_empty (self):
 187         return len (self.start) + len (self.end) == 0
 188     def add_start (self, g):
 189         self.start[getattr (g, 'number', "1")] = g
 190     def add_end (self, g):
 191         self.end[getattr (g, 'number', "1")] = g
 192     def print_ly (self, printer):
 193         error_message ("Unprocessed PartGroupInfo %s encountered" % self)
 194     def ly_expression (self):
 195         error_message ("Unprocessed PartGroupInfo %s encountered" % self)
 196         return ''
 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 = musicxml_step_to_lily (step)
 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     'beam' : musicexp.BeamEvent,
 709     'dashes' : musicexp.TextSpannerEvent,
 710     'bracket' : musicexp.BracketSpannerEvent,
 711     'glissando' : musicexp.GlissandoEvent,
 712     'octave-shift' : musicexp.OctaveShiftEvent,
 713     'pedal' : musicexp.PedalEvent,
 714     'slur' : musicexp.SlurEvent,
 715     'wavy-line' : musicexp.TrillSpanEvent,
 716     'wedge' : musicexp.HairpinEvent
 717 }
 718 spanner_type_dict = {
 719     'start': -1,
 720     'begin': -1,
 721     'crescendo': -1,
 722     'decreschendo': -1,
 723     'diminuendo': -1,
 724     'continue': 0,
 725     'change': 0,
 726     'up': -1,
 727     'down': -1,
 728     'stop': 1,
 729     'end' : 1
 730 }
 731
 732 def musicxml_spanner_to_lily_event (mxl_event):
 733     ev = None
 734
 735     name = mxl_event.get_name()
 736     func = spanner_event_dict.get (name)
 737     if func:
 738         ev = func()
 739     else:
 740         error_message ('unknown span event %s' % mxl_event)
 741
 742
 743     type = mxl_event.get_type ()
 744     span_direction = spanner_type_dict.get (type)
 745     # really check for None, because some types will be translated to 0, which
 746     # would otherwise also lead to the unknown span warning
 747     if span_direction != None:
 748         ev.span_direction = span_direction
 749     else:
 750         error_message ('unknown span type %s for %s' % (type, name))
 751
 752     ev.set_span_type (type)
 753     ev.line_type = getattr (mxl_event, 'line-type', 'solid')
 754
 755     # assign the size, which is used for octave-shift, etc.
 756     ev.size = mxl_event.get_size ()
 757
 758     return ev
 759
 760 def musicxml_direction_to_indicator (direction):
 761     return { "above": 1, "upright": 1, "up":1, "below": -1, "downright": -1, "down": -1, "inverted": -1 }.get (direction, 0)
 762
 763 def musicxml_fermata_to_lily_event (mxl_event):
 764     ev = musicexp.ArticulationEvent ()
 765     txt = mxl_event.get_text ()
 766     # The contents of the element defined the shape, possible are normal, angled and square
 767     ev.type = { "angled": "shortfermata", "square": "longfermata" }.get (txt, "fermata")
 768     if hasattr (mxl_event, 'type'):
 769       dir = musicxml_direction_to_indicator (mxl_event.type)
 770       if dir and options.convert_directions:
 771         ev.force_direction = dir
 772     return ev
 773
 774 def musicxml_arpeggiate_to_lily_event (mxl_event):
 775     ev = musicexp.ArpeggioEvent ()
 776     ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
 777     return ev
 778
 779 def musicxml_tremolo_to_lily_event (mxl_event):
 780     ev = musicexp.TremoloEvent ()
 781     txt = mxl_event.get_text ()
 782     if txt:
 783       ev.bars = txt
 784     else:
 785       ev.bars = "3"
 786     return ev
 787
 788 def musicxml_falloff_to_lily_event (mxl_event):
 789     ev = musicexp.BendEvent ()
 790     ev.alter = -4
 791     return ev
 792
 793 def musicxml_doit_to_lily_event (mxl_event):
 794     ev = musicexp.BendEvent ()
 795     ev.alter = 4
 796     return ev
 797
 798 def musicxml_bend_to_lily_event (mxl_event):
 799     ev = musicexp.BendEvent ()
 800     ev.alter = mxl_event.bend_alter ()
 801     return ev
 802
 803 def musicxml_caesura_to_lily_event (mxl_event):
 804     ev = musicexp.MarkupEvent ()
 805     # FIXME: default to straight or curved caesura?
 806     ev.contents = "\\musicglyph #\"scripts.caesura.straight\""
 807     ev.force_direction = 1
 808     return ev
 809
 810 def musicxml_fingering_event (mxl_event):
 811     ev = musicexp.ShortArticulationEvent ()
 812     ev.type = mxl_event.get_text ()
 813     return ev
 814
 815 def musicxml_snappizzicato_event (mxl_event):
 816     needed_additional_definitions.append ("snappizzicato")
 817     ev = musicexp.MarkupEvent ()
 818     ev.contents = "\\snappizzicato"
 819     return ev
 820
 821 def musicxml_string_event (mxl_event):
 822     ev = musicexp.NoDirectionArticulationEvent ()
 823     ev.type = mxl_event.get_text ()
 824     return ev
 825
 826 def musicxml_accidental_mark (mxl_event):
 827     ev = musicexp.MarkupEvent ()
 828     contents = { "sharp": "\\sharp",
 829       "natural": "\\natural",
 830       "flat": "\\flat",
 831       "double-sharp": "\\doublesharp",
 832       "sharp-sharp": "\\sharp\\sharp",
 833       "flat-flat": "\\flat\\flat",
 834       "flat-flat": "\\doubleflat",
 835       "natural-sharp": "\\natural\\sharp",
 836       "natural-flat": "\\natural\\flat",
 837       "quarter-flat": "\\semiflat",
 838       "quarter-sharp": "\\semisharp",
 839       "three-quarters-flat": "\\sesquiflat",
 840       "three-quarters-sharp": "\\sesquisharp",
 841     }.get (mxl_event.get_text ())
 842     if contents:
 843         ev.contents = contents
 844         return ev
 845     else:
 846         return None
 847
 848 # translate articulations, ornaments and other notations into ArticulationEvents
 849 # possible values:
 850 #   -) string  (ArticulationEvent with that name)
 851 #   -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
 852 #   -) (class, name)  (like string, only that a different class than ArticulationEvent is used)
 853 # TODO: Some translations are missing!
 854 articulations_dict = {
 855     "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
 856     "accidental-mark": musicxml_accidental_mark,
 857     "bend": musicxml_bend_to_lily_event,
 858     "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
 859     "caesura": musicxml_caesura_to_lily_event,
 860     #"delayed-turn": "?",
 861     "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
 862     "doit": musicxml_doit_to_lily_event,
 863     #"double-tongue": "",
 864     "down-bow": "downbow",
 865     "falloff": musicxml_falloff_to_lily_event,
 866     "fingering": musicxml_fingering_event,
 867     #"fingernails": "",
 868     #"fret": "",
 869     #"hammer-on": "",
 870     "harmonic": "flageolet",
 871     #"heel": "",
 872     "inverted-mordent": "prall",
 873     "inverted-turn": "reverseturn",
 874     "mordent": "mordent",
 875     "open-string": "open",
 876     #"plop": "",
 877     #"pluck": "",
 878     #"pull-off": "",
 879     #"schleifer": "?",
 880     #"scoop": "",
 881     #"shake": "?",
 882     "snap-pizzicato": musicxml_snappizzicato_event,
 883     #"spiccato": "",
 884     "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
 885     "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
 886     "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
 887     #"stress": "",
 888     "string": musicxml_string_event,
 889     "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
 890     #"tap": "",
 891     "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
 892     "thumb-position": "thumb",
 893     #"toe": "",
 894     "turn": "turn",
 895     "tremolo": musicxml_tremolo_to_lily_event,
 896     "trill-mark": "trill",
 897     #"triple-tongue": "",
 898     #"unstress": ""
 899     "up-bow": "upbow",
 900     #"wavy-line": "?",
 901 }
 902 articulation_spanners = [ "wavy-line" ]
 903
 904 def musicxml_articulation_to_lily_event (mxl_event):
 905     # wavy-line elements are treated as trill spanners, not as articulation ornaments
 906     if mxl_event.get_name () in articulation_spanners:
 907         return musicxml_spanner_to_lily_event (mxl_event)
 908
 909     tmp_tp = articulations_dict.get (mxl_event.get_name ())
 910     if not tmp_tp:
 911         return
 912
 913     if isinstance (tmp_tp, str):
 914         ev = musicexp.ArticulationEvent ()
 915         ev.type = tmp_tp
 916     elif isinstance (tmp_tp, tuple):
 917         ev = tmp_tp[0] ()
 918         ev.type = tmp_tp[1]
 919     else:
 920         ev = tmp_tp (mxl_event)
 921
 922     # Some articulations use the type attribute, other the placement...
 923     dir = None
 924     if hasattr (mxl_event, 'type') and options.convert_directions:
 925         dir = musicxml_direction_to_indicator (mxl_event.type)
 926     if hasattr (mxl_event, 'placement') and options.convert_directions:
 927         dir = musicxml_direction_to_indicator (mxl_event.placement)
 928     if dir:
 929         ev.force_direction = dir
 930     return ev
 931
 932
 933
 934 def musicxml_dynamics_to_lily_event (dynentry):
 935     dynamics_available = (
 936         "ppppp", "pppp", "ppp", "pp", "p", "mp", "mf",
 937         "f", "ff", "fff", "ffff", "fp", "sf", "sff", "sp", "spp", "sfz", "rfz" )
 938     dynamicsname = dynentry.get_name ()
 939     if dynamicsname == "other-dynamics":
 940         dynamicsname = dynentry.get_text ()
 941     if not dynamicsname or dynamicsname=="#text":
 942         return
 943
 944     if not dynamicsname in dynamics_available:
 945         # Get rid of - in tag names (illegal in ly tags!)
 946         dynamicstext = dynamicsname
 947         dynamicsname = string.replace (dynamicsname, "-", "")
 948         additional_definitions[dynamicsname] = dynamicsname + \
 949               " = #(make-dynamic-script \"" + dynamicstext + "\")"
 950         needed_additional_definitions.append (dynamicsname)
 951     event = musicexp.DynamicsEvent ()
 952     event.type = dynamicsname
 953     return event
 954
 955 # Convert single-color two-byte strings to numbers 0.0 - 1.0
 956 def hexcolorval_to_nr (hex_val):
 957     try:
 958         v = int (hex_val, 16)
 959         if v == 255:
 960             v = 256
 961         return v / 256.
 962     except ValueError:
 963         return 0.
 964
 965 def hex_to_color (hex_val):
 966     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)
 967     if res:
 968         return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
 969     else:
 970         return None
 971
 972 def musicxml_words_to_lily_event (words):
 973     event = musicexp.TextEvent ()
 974     text = words.get_text ()
 975     text = re.sub ('^ *\n? *', '', text)
 976     text = re.sub (' *\n? *$', '', text)
 977     event.text = text
 978
 979     if hasattr (words, 'default-y') and options.convert_directions:
 980         offset = getattr (words, 'default-y')
 981         try:
 982             off = string.atoi (offset)
 983             if off > 0:
 984                 event.force_direction = 1
 985             else:
 986                 event.force_direction = -1
 987         except ValueError:
 988             event.force_direction = 0
 989
 990     if hasattr (words, 'font-weight'):
 991         font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
 992         if font_weight:
 993             event.markup += font_weight
 994
 995     if hasattr (words, 'font-size'):
 996         size = getattr (words, 'font-size')
 997         font_size = {
 998             "xx-small": '\\teeny',
 999             "x-small": '\\tiny',
1000             "small": '\\small',
1001             "medium": '',
1002             "large": '\\large',
1003             "x-large": '\\huge',
1004             "xx-large": '\\bigger\\huge'
1005         }.get (size, '')
1006         if font_size:
1007             event.markup += font_size
1008
1009     if hasattr (words, 'color'):
1010         color = getattr (words, 'color')
1011         rgb = hex_to_color (color)
1012         if rgb:
1013             event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
1014
1015     if hasattr (words, 'font-style'):
1016         font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
1017         if font_style:
1018             event.markup += font_style
1019
1020     # TODO: How should I best convert the font-family attribute?
1021
1022     # TODO: How can I represent the underline, overline and line-through
1023     #       attributes in Lilypond? Values of these attributes indicate
1024     #       the number of lines
1025
1026     return event
1027
1028
1029 # convert accordion-registration to lilypond.
1030 # Since lilypond does not have any built-in commands, we need to create
1031 # the markup commands manually and define our own variables.
1032 # Idea was taken from: http://lsr.dsi.unimi.it/LSR/Item?id=194
1033 def musicxml_accordion_to_markup (mxl_event):
1034     commandname = "accReg"
1035     command = ""
1036
1037     high = mxl_event.get_maybe_exist_named_child ('accordion-high')
1038     if high:
1039         commandname += "H"
1040         command += """\\combine
1041           \\raise #2.5 \\musicglyph #\"accordion.accDot\"
1042           """
1043     middle = mxl_event.get_maybe_exist_named_child ('accordion-middle')
1044     if middle:
1045         txt = 1
1046         try:
1047           txt = string.atoi (middle.get_text ())
1048         except ValueError:
1049             pass
1050         if txt == 3:
1051             commandname += "MMM"
1052             command += """\\combine
1053           \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1054           \\combine
1055           \\raise #1.5 \\translate #(cons 1 0) \\musicglyph #\"accordion.accDot\"
1056           \\combine
1057           \\raise #1.5 \\translate #(cons -1 0) \\musicglyph #\"accordion.accDot\"
1058           """
1059         elif txt == 2:
1060             commandname += "MM"
1061             command += """\\combine
1062           \\raise #1.5 \\translate #(cons 0.5 0) \\musicglyph #\"accordion.accDot\"
1063           \\combine
1064           \\raise #1.5 \\translate #(cons -0.5 0) \\musicglyph #\"accordion.accDot\"
1065           """
1066         elif not txt <= 0:
1067             commandname += "M"
1068             command += """\\combine
1069           \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1070           """
1071     low = mxl_event.get_maybe_exist_named_child ('accordion-low')
1072     if low:
1073         commandname += "L"
1074         command += """\\combine
1075           \\raise #0.5 \musicglyph #\"accordion.accDot\"
1076           """
1077
1078     command += "\musicglyph #\"accordion.accDiscant\""
1079     command = "\\markup { \\normalsize %s }" % command
1080     additional_definitions[commandname] = "%s = %s" % (commandname, command)
1081     print additional_definitions
1082     needed_additional_definitions.append (commandname)
1083     return "\\%s" % commandname
1084
1085 def musicxml_accordion_to_ly (mxl_event):
1086     txt = musicxml_accordion_to_markup (mxl_event)
1087     if txt:
1088         ev = musicexp.MarkEvent (txt)
1089         return ev
1090     return
1091
1092
1093 def musicxml_rehearsal_to_ly_mark (mxl_event):
1094     text = mxl_event.get_text ()
1095     if not text:
1096         return
1097     # default is boxed rehearsal marks!
1098     encl = "box"
1099     if hasattr (mxl_event, 'enclosure'):
1100         encl = {"none": None, "square": "box", "circle": "circle" }.get (mxl_event.enclosure, None)
1101     if encl:
1102         text = "\\%s { %s }" % (encl, text)
1103     ev = musicexp.MarkEvent ("\\markup { %s }" % text)
1104     return ev
1105
1106 # translate directions into Events, possible values:
1107 #   -) string  (MarkEvent with that command)
1108 #   -) function (function(mxl_event) needs to return a full Event-derived object
1109 #   -) (class, name)  (like string, only that a different class than MarkEvent is used)
1110 directions_dict = {
1111     'accordion-registration' : musicxml_accordion_to_ly,
1112     'coda' : (musicexp.MusicGlyphMarkEvent, "coda"),
1113 #     'damp' : ???
1114 #     'damp-all' : ???
1115 #     'eyeglasses': ??????
1116 #     'harp-pedals' :
1117 #     'image' :
1118 #     'metronome' :
1119     'rehearsal' : musicxml_rehearsal_to_ly_mark,
1120 #     'scordatura' :
1121     'segno' : (musicexp.MusicGlyphMarkEvent, "segno"),
1122     'words' : musicxml_words_to_lily_event,
1123 }
1124 directions_spanners = [ 'octave-shift', 'pedal', 'wedge', 'dashes', 'bracket' ]
1125
1126 def musicxml_direction_to_lily (n):
1127     # TODO: Handle the <staff> element!
1128     res = []
1129     # placement applies to all children!
1130     dir = None
1131     if hasattr (n, 'placement') and options.convert_directions:
1132         dir = musicxml_direction_to_indicator (n.placement)
1133     dirtype_children = []
1134     # TODO: The direction-type is used for grouping (e.g. dynamics with text),
1135     #       so we can't simply flatten them out!
1136     for dt in n.get_typed_children (musicxml.DirType):
1137         dirtype_children += dt.get_all_children ()
1138
1139     for entry in dirtype_children:
1140         # backets, dashes, octave shifts. pedal marks, hairpins etc. are spanners:
1141         if entry.get_name() in directions_spanners:
1142             event = musicxml_spanner_to_lily_event (entry)
1143             if event:
1144                 res.append (event)
1145             continue
1146
1147         # now treat all the "simple" ones, that can be translated using the dict
1148         ev = None
1149         tmp_tp = directions_dict.get (entry.get_name (), None)
1150         if isinstance (tmp_tp, str): # string means MarkEvent
1151             ev = musicexp.MarkEvent (tmp_tp)
1152         elif isinstance (tmp_tp, tuple): # tuple means (EventClass, "text")
1153             ev = tmp_tp[0] (tmp_tp[1])
1154         elif tmp_tp:
1155             ev = tmp_tp (entry)
1156         if ev:
1157             # TODO: set the correct direction! Unfortunately, \mark in ly does
1158             #       not seem to support directions!
1159             res.append (ev)
1160             continue
1161
1162         if entry.get_name () == "dynamics":
1163             for dynentry in entry.get_all_children ():
1164                 ev = musicxml_dynamics_to_lily_event (dynentry)
1165                 if ev:
1166                     res.append (ev)
1167
1168     return res
1169
1170 def musicxml_frame_to_lily_event (frame):
1171     ev = musicexp.FretEvent ()
1172     ev.strings = frame.get_strings ()
1173     ev.frets = frame.get_frets ()
1174     #offset = frame.get_first_fret () - 1
1175     barre = []
1176     for fn in frame.get_named_children ('frame-note'):
1177         fret = fn.get_fret ()
1178         if fret <= 0:
1179             fret = "o"
1180         el = [ fn.get_string (), fret ]
1181         fingering = fn.get_fingering ()
1182         if fingering >= 0:
1183             el.append (fingering)
1184         ev.elements.append (el)
1185         b = fn.get_barre ()
1186         if b == 'start':
1187             barre[0] = el[0] # start string
1188             barre[2] = el[1] # fret
1189         elif b == 'stop':
1190             barre[1] = el[0] # end string
1191     if barre:
1192         ev.barre = barre
1193     return ev
1194
1195 def musicxml_harmony_to_lily (n):
1196     res = []
1197     for f in n.get_named_children ('frame'):
1198         ev = musicxml_frame_to_lily_event (f)
1199         if ev:
1200             res.append (ev)
1201
1202     return res
1203
1204 instrument_drumtype_dict = {
1205     'Acoustic Snare Drum': 'acousticsnare',
1206     'Side Stick': 'sidestick',
1207     'Open Triangle': 'opentriangle',
1208     'Mute Triangle': 'mutetriangle',
1209     'Tambourine': 'tambourine',
1210     'Bass Drum': 'bassdrum',
1211 }
1212
1213 def musicxml_note_to_lily_main_event (n):
1214     pitch  = None
1215     duration = None
1216     event = None
1217
1218     mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1219     if mxl_pitch:
1220         pitch = musicxml_pitch_to_lily (mxl_pitch)
1221         event = musicexp.NoteEvent ()
1222         event.pitch = pitch
1223
1224         acc = n.get_maybe_exist_named_child ('accidental')
1225         if acc:
1226             # let's not force accs everywhere.
1227             event.cautionary = acc.editorial
1228
1229     elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1230         # Unpitched elements have display-step and can also have
1231         # display-octave.
1232         unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1233         event = musicexp.NoteEvent ()
1234         event.pitch = musicxml_unpitched_to_lily (unpitched)
1235
1236     elif n.get_maybe_exist_typed_child (musicxml.Rest):
1237         # rests can have display-octave and display-step, which are
1238         # treated like an ordinary note pitch
1239         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1240         event = musicexp.RestEvent ()
1241         pitch = musicxml_restdisplay_to_lily (rest)
1242         event.pitch = pitch
1243
1244     elif n.instrument_name:
1245         event = musicexp.NoteEvent ()
1246         drum_type = instrument_drumtype_dict.get (n.instrument_name)
1247         if drum_type:
1248             event.drum_type = drum_type
1249         else:
1250             n.message ("drum %s type unknown, please add to instrument_drumtype_dict" % n.instrument_name)
1251             event.drum_type = 'acousticsnare'
1252
1253     else:
1254         n.message ("cannot find suitable event")
1255
1256     if event:
1257         event.duration = musicxml_duration_to_lily (n)
1258
1259     return event
1260
1261
1262 ## TODO
1263 class NegativeSkip:
1264     def __init__ (self, here, dest):
1265         self.here = here
1266         self.dest = dest
1267
1268 class LilyPondVoiceBuilder:
1269     def __init__ (self):
1270         self.elements = []
1271         self.pending_dynamics = []
1272         self.end_moment = Rational (0)
1273         self.begin_moment = Rational (0)
1274         self.pending_multibar = Rational (0)
1275         self.ignore_skips = False
1276
1277     def _insert_multibar (self):
1278         r = musicexp.MultiMeasureRest ()
1279         r.duration = musicexp.Duration()
1280         r.duration.duration_log = 0
1281         r.duration.factor = self.pending_multibar
1282         self.elements.append (r)
1283         self.begin_moment = self.end_moment
1284         self.end_moment = self.begin_moment + self.pending_multibar
1285         self.pending_multibar = Rational (0)
1286
1287     def add_multibar_rest (self, duration):
1288         self.pending_multibar += duration
1289
1290     def set_duration (self, duration):
1291         self.end_moment = self.begin_moment + duration
1292     def current_duration (self):
1293         return self.end_moment - self.begin_moment
1294
1295     def add_music (self, music, duration):
1296         assert isinstance (music, musicexp.Music)
1297         if self.pending_multibar > Rational (0):
1298             self._insert_multibar ()
1299
1300         self.elements.append (music)
1301         self.begin_moment = self.end_moment
1302         self.set_duration (duration)
1303
1304         # Insert all pending dynamics right after the note/rest:
1305         if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1306             for d in self.pending_dynamics:
1307                 music.append (d)
1308             self.pending_dynamics = []
1309
1310     # Insert some music command that does not affect the position in the measure
1311     def add_command (self, command):
1312         assert isinstance (command, musicexp.Music)
1313         if self.pending_multibar > Rational (0):
1314             self._insert_multibar ()
1315         self.elements.append (command)
1316     def add_barline (self, barline):
1317         # TODO: Implement merging of default barline and custom bar line
1318         self.add_music (barline, Rational (0))
1319     def add_partial (self, command):
1320         self.ignore_skips = True
1321         self.add_command (command)
1322
1323     def add_dynamics (self, dynamic):
1324         # store the dynamic item(s) until we encounter the next note/rest:
1325         self.pending_dynamics.append (dynamic)
1326
1327     def add_bar_check (self, number):
1328         b = musicexp.BarLine ()
1329         b.bar_number = number
1330         self.add_barline (b)
1331
1332     def jumpto (self, moment):
1333         current_end = self.end_moment + self.pending_multibar
1334         diff = moment - current_end
1335
1336         if diff < Rational (0):
1337             error_message ('Negative skip %s' % diff)
1338             diff = Rational (0)
1339
1340         if diff > Rational (0) and not (self.ignore_skips and moment == 0):
1341             skip = musicexp.SkipEvent()
1342             duration_factor = 1
1343             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)
1344             duration_dots = 0
1345             if duration_log > 0: # denominator is a power of 2...
1346                 if diff.numerator () == 3:
1347                     duration_log -= 1
1348                     duration_dots = 1
1349                 else:
1350                     duration_factor = Rational (diff.numerator ())
1351             else:
1352                 duration_log = 0
1353                 duration_factor = diff
1354             skip.duration.duration_log = duration_log
1355             skip.duration.factor = duration_factor
1356             skip.duration.dots = duration_dots
1357
1358             evc = musicexp.ChordEvent ()
1359             evc.elements.append (skip)
1360             self.add_music (evc, diff)
1361
1362         if diff > Rational (0) and moment == 0:
1363             self.ignore_skips = False
1364
1365     def last_event_chord (self, starting_at):
1366
1367         value = None
1368
1369         # if the position matches, find the last ChordEvent, do not cross a bar line!
1370         at = len( self.elements ) - 1
1371         while (at >= 0 and
1372                not isinstance (self.elements[at], musicexp.ChordEvent) and
1373                not isinstance (self.elements[at], musicexp.BarLine)):
1374             at -= 1
1375
1376         if (self.elements
1377             and at >= 0
1378             and isinstance (self.elements[at], musicexp.ChordEvent)
1379             and self.begin_moment == starting_at):
1380             value = self.elements[at]
1381         else:
1382             self.jumpto (starting_at)
1383             value = None
1384         return value
1385
1386     def correct_negative_skip (self, goto):
1387         self.end_moment = goto
1388         self.begin_moment = goto
1389         evc = musicexp.ChordEvent ()
1390         self.elements.append (evc)
1391
1392
1393 class VoiceData:
1394     def __init__ (self):
1395         self.voicedata = None
1396         self.ly_voice = None
1397         self.lyrics_dict = {}
1398         self.lyrics_order = []
1399
1400 def musicxml_step_to_lily (step):
1401     if step:
1402         return (ord (step) - ord ('A') + 7 - 2) % 7
1403     else:
1404         return None
1405
1406 def musicxml_voice_to_lily_voice (voice):
1407     tuplet_events = []
1408     modes_found = {}
1409     lyrics = {}
1410     return_value = VoiceData ()
1411     return_value.voicedata = voice
1412
1413     # First pitch needed for relative mode (if selected in command-line options)
1414     first_pitch = None
1415
1416     # Needed for melismata detection (ignore lyrics on those notes!):
1417     inside_slur = False
1418     is_tied = False
1419     is_chord = False
1420     ignore_lyrics = False
1421
1422     current_staff = None
1423
1424     # Make sure that the keys in the dict don't get reordered, since
1425     # we need the correct ordering of the lyrics stanzas! By default,
1426     # a dict will reorder its keys
1427     return_value.lyrics_order = voice.get_lyrics_numbers ()
1428     for k in return_value.lyrics_order:
1429         lyrics[k] = []
1430
1431     voice_builder = LilyPondVoiceBuilder()
1432
1433     for n in voice._elements:
1434         if n.get_name () == 'forward':
1435             continue
1436         staff = n.get_maybe_exist_named_child ('staff')
1437         if staff:
1438             staff = staff.get_text ()
1439             if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
1440                 voice_builder.add_command (musicexp.StaffChange (staff))
1441             current_staff = staff
1442
1443         if isinstance (n, musicxml.Partial) and n.partial > 0:
1444             a = musicxml_partial_to_lily (n.partial)
1445             if a:
1446                 voice_builder.add_partial (a)
1447             continue
1448
1449         if isinstance (n, musicxml.Direction):
1450             for a in musicxml_direction_to_lily (n):
1451                 if a.wait_for_note ():
1452                     voice_builder.add_dynamics (a)
1453                 else:
1454                     voice_builder.add_command (a)
1455             continue
1456
1457         if isinstance (n, musicxml.Harmony):
1458             for a in musicxml_harmony_to_lily (n):
1459                 if a.wait_for_note ():
1460                     voice_builder.add_dynamics (a)
1461                 else:
1462                     voice_builder.add_command (a)
1463             continue
1464
1465         is_chord = n.get_maybe_exist_named_child ('chord')
1466         if not is_chord:
1467             try:
1468                 voice_builder.jumpto (n._when)
1469             except NegativeSkip, neg:
1470                 voice_builder.correct_negative_skip (n._when)
1471                 n.message ("Negative skip? from %s to %s, diff %s" % (neg.here, neg.dest, neg.dest - neg.here))
1472
1473         if isinstance (n, musicxml.Attributes):
1474             if n.is_first () and n._measure_position == Rational (0):
1475                 try:
1476                     number = int (n.get_parent ().number)
1477                 except ValueError:
1478                     number = 0
1479                 if number > 0:
1480                     voice_builder.add_bar_check (number)
1481
1482             for a in musicxml_attributes_to_lily (n):
1483                 voice_builder.add_command (a)
1484             continue
1485
1486         if isinstance (n, musicxml.Barline):
1487             barlines = musicxml_barline_to_lily (n)
1488             for a in barlines:
1489                 if isinstance (a, musicexp.BarLine):
1490                     voice_builder.add_barline (a)
1491                 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
1492                     voice_builder.add_command (a)
1493             continue
1494
1495         if not n.__class__.__name__ == 'Note':
1496             error_message ('not a Note or Attributes? %s' % n)
1497             continue
1498
1499         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1500         if (rest
1501             and rest.is_whole_measure ()):
1502
1503             voice_builder.add_multibar_rest (n._duration)
1504             continue
1505
1506         if n.is_first () and n._measure_position == Rational (0):
1507             try:
1508                 num = int (n.get_parent ().number)
1509             except ValueError:
1510                 num = 0
1511             if num > 0:
1512                 voice_builder.add_bar_check (num)
1513
1514         main_event = musicxml_note_to_lily_main_event (n)
1515         if main_event and not first_pitch:
1516             first_pitch = main_event.pitch
1517         ignore_lyrics = inside_slur or is_tied or is_chord
1518
1519         if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
1520             modes_found['drummode'] = True
1521
1522         ev_chord = voice_builder.last_event_chord (n._when)
1523         if not ev_chord:
1524             ev_chord = musicexp.ChordEvent()
1525             voice_builder.add_music (ev_chord, n._duration)
1526
1527         grace = n.get_maybe_exist_typed_child (musicxml.Grace)
1528         if grace:
1529             grace_chord = None
1530             if n.get_maybe_exist_typed_child (musicxml.Chord) and ev_chord.grace_elements:
1531                 grace_chord = ev_chord.grace_elements.get_last_event_chord ()
1532             if not grace_chord:
1533                 grace_chord = musicexp.ChordEvent ()
1534                 ev_chord.append_grace (grace_chord)
1535             if hasattr (grace, 'slash'):
1536                 # TODO: use grace_type = "appoggiatura" for slurred grace notes
1537                 if grace.slash == "yes":
1538                     ev_chord.grace_type = "acciaccatura"
1539             # now that we have inserted the chord into the grace music, insert
1540             # everything into that chord instead of the ev_chord
1541             ev_chord = grace_chord
1542             ev_chord.append (main_event)
1543             ignore_lyrics = True
1544         else:
1545             ev_chord.append (main_event)
1546             # When a note/chord has grace notes (duration==0), the duration of the
1547             # event chord is not yet known, but the event chord was already added
1548             # with duration 0. The following correct this when we hit the real note!
1549             if voice_builder.current_duration () == 0 and n._duration > 0:
1550                 voice_builder.set_duration (n._duration)
1551
1552         notations_children = n.get_typed_children (musicxml.Notations)
1553         tuplet_event = None
1554         span_events = []
1555
1556         # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
1557         # +tied | +slur | +tuplet | glissando | slide |
1558         #    ornaments | technical | articulations | dynamics |
1559         #    +fermata | arpeggiate | non-arpeggiate |
1560         #    accidental-mark | other-notation
1561         for notations in notations_children:
1562             for tuplet_event in notations.get_tuplets():
1563                 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1564                 frac = (1,1)
1565                 if mod:
1566                     frac = mod.get_fraction ()
1567
1568                 tuplet_events.append ((ev_chord, tuplet_event, frac))
1569
1570             slurs = [s for s in notations.get_named_children ('slur')
1571                 if s.get_type () in ('start','stop')]
1572             if slurs:
1573                 if len (slurs) > 1:
1574                     error_message ('more than 1 slur?')
1575                 # record the slur status for the next note in the loop
1576                 if not grace:
1577                     if slurs[0].get_type () == 'start':
1578                         inside_slur = True
1579                     elif slurs[0].get_type () == 'stop':
1580                         inside_slur = False
1581                 lily_ev = musicxml_spanner_to_lily_event (slurs[0])
1582                 ev_chord.append (lily_ev)
1583
1584             if not grace:
1585                 mxl_tie = notations.get_tie ()
1586                 if mxl_tie and mxl_tie.type == 'start':
1587                     ev_chord.append (musicexp.TieEvent ())
1588                     is_tied = True
1589                 else:
1590                     is_tied = False
1591
1592             fermatas = notations.get_named_children ('fermata')
1593             for a in fermatas:
1594                 ev = musicxml_fermata_to_lily_event (a)
1595                 if ev:
1596                     ev_chord.append (ev)
1597
1598             arpeggiate = notations.get_named_children ('arpeggiate')
1599             for a in arpeggiate:
1600                 ev = musicxml_arpeggiate_to_lily_event (a)
1601                 if ev:
1602                     ev_chord.append (ev)
1603
1604             glissandos = notations.get_named_children ('glissando')
1605             for a in glissandos:
1606                 ev = musicxml_spanner_to_lily_event (a)
1607                 if ev:
1608                     ev_chord.append (ev)
1609
1610             # Articulations can contain the following child elements:
1611             #         accent | strong-accent | staccato | tenuto |
1612             #         detached-legato | staccatissimo | spiccato |
1613             #         scoop | plop | doit | falloff | breath-mark |
1614             #         caesura | stress | unstress
1615             # Technical can contain the following child elements:
1616             #         up-bow | down-bow | harmonic | open-string |
1617             #         thumb-position | fingering | pluck | double-tongue |
1618             #         triple-tongue | stopped | snap-pizzicato | fret |
1619             #         string | hammer-on | pull-off | bend | tap | heel |
1620             #         toe | fingernails | other-technical
1621             # Ornaments can contain the following child elements:
1622             #         trill-mark | turn | delayed-turn | inverted-turn |
1623             #         shake | wavy-line | mordent | inverted-mordent |
1624             #         schleifer | tremolo | other-ornament, accidental-mark
1625             ornaments = notations.get_named_children ('ornaments')
1626             ornaments += notations.get_named_children ('articulations')
1627             ornaments += notations.get_named_children ('technical')
1628
1629             for a in ornaments:
1630                 for ch in a.get_all_children ():
1631                     ev = musicxml_articulation_to_lily_event (ch)
1632                     if ev:
1633                         ev_chord.append (ev)
1634
1635             dynamics = notations.get_named_children ('dynamics')
1636             for a in dynamics:
1637                 for ch in a.get_all_children ():
1638                     ev = musicxml_dynamics_to_lily_event (ch)
1639                     if ev:
1640                         ev_chord.append (ev)
1641
1642         # Extract the lyrics
1643         if not rest and not ignore_lyrics:
1644             note_lyrics_processed = []
1645             note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
1646             for l in note_lyrics_elements:
1647                 if l.get_number () < 0:
1648                     for k in lyrics.keys ():
1649                         lyrics[k].append (l.lyric_to_text ())
1650                         note_lyrics_processed.append (k)
1651                 else:
1652                     lyrics[l.number].append(l.lyric_to_text ())
1653                     note_lyrics_processed.append (l.number)
1654             for lnr in lyrics.keys ():
1655                 if not lnr in note_lyrics_processed:
1656                     lyrics[lnr].append ("\skip4")
1657
1658
1659         mxl_beams = [b for b in n.get_named_children ('beam')
1660                      if (b.get_type () in ('begin', 'end')
1661                          and b.is_primary ())]
1662         if mxl_beams:
1663             beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
1664             if beam_ev:
1665                 ev_chord.append (beam_ev)
1666
1667         if tuplet_event:
1668             mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1669             frac = (1,1)
1670             if mod:
1671                 frac = mod.get_fraction ()
1672
1673             tuplet_events.append ((ev_chord, tuplet_event, frac))
1674
1675     ## force trailing mm rests to be written out.
1676     voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
1677
1678     ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
1679     ly_voice = group_repeats (ly_voice)
1680
1681     seq_music = musicexp.SequentialMusic ()
1682
1683     if 'drummode' in modes_found.keys ():
1684         ## \key <pitch> barfs in drummode.
1685         ly_voice = [e for e in ly_voice
1686                     if not isinstance(e, musicexp.KeySignatureChange)]
1687
1688     seq_music.elements = ly_voice
1689     for k in lyrics.keys ():
1690         return_value.lyrics_dict[k] = musicexp.Lyrics ()
1691         return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
1692
1693
1694     if len (modes_found) > 1:
1695        error_message ('Too many modes found %s' % modes_found.keys ())
1696
1697     if options.relative:
1698         v = musicexp.RelativeMusic ()
1699         v.element = seq_music
1700         v.basepitch = first_pitch
1701         seq_music = v
1702
1703     return_value.ly_voice = seq_music
1704     for mode in modes_found.keys ():
1705         v = musicexp.ModeChangingMusicWrapper()
1706         v.element = seq_music
1707         v.mode = mode
1708         return_value.ly_voice = v
1709
1710     return return_value
1711
1712 def musicxml_id_to_lily (id):
1713     digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
1714               'Six', 'Seven', 'Eight', 'Nine', 'Ten']
1715
1716     for digit in digits:
1717         d = digits.index (digit)
1718         id = re.sub ('%d' % d, digit, id)
1719
1720     id = re.sub  ('[^a-zA-Z]', 'X', id)
1721     return id
1722
1723 def musicxml_pitch_to_lily (mxl_pitch):
1724     p = musicexp.Pitch ()
1725     p.alteration = mxl_pitch.get_alteration ()
1726     p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
1727     p.octave = mxl_pitch.get_octave () - 4
1728     return p
1729
1730 def musicxml_unpitched_to_lily (mxl_unpitched):
1731     p = None
1732     step = mxl_unpitched.get_step ()
1733     if step:
1734         p = musicexp.Pitch ()
1735         p.step = musicxml_step_to_lily (step)
1736     octave = mxl_unpitched.get_octave ()
1737     if octave and p:
1738         p.octave = octave - 4
1739     return p
1740
1741 def musicxml_restdisplay_to_lily (mxl_rest):
1742     p = None
1743     step = mxl_rest.get_step ()
1744     if step:
1745         p = musicexp.Pitch ()
1746         p.step = musicxml_step_to_lily (step)
1747     octave = mxl_rest.get_octave ()
1748     if octave and p:
1749         p.octave = octave - 4
1750     return p
1751
1752 def voices_in_part (part):
1753     """Return a Name -> Voice dictionary for PART"""
1754     part.interpret ()
1755     part.extract_voices ()
1756     voices = part.get_voices ()
1757     part_info = part.get_staff_attributes ()
1758
1759     return (voices, part_info)
1760
1761 def voices_in_part_in_parts (parts):
1762     """return a Part -> Name -> Voice dictionary"""
1763     return dict([(p.id, voices_in_part (p)) for p in parts])
1764
1765
1766 def get_all_voices (parts):
1767     all_voices = voices_in_part_in_parts (parts)
1768
1769     all_ly_voices = {}
1770     all_ly_staffinfo = {}
1771     for p, (name_voice, staff_info) in all_voices.items ():
1772
1773         part_ly_voices = {}
1774         for n, v in name_voice.items ():
1775             progress ("Converting to LilyPond expressions...")
1776             # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
1777             part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
1778
1779         all_ly_voices[p] = part_ly_voices
1780         all_ly_staffinfo[p] = staff_info
1781
1782     return (all_ly_voices, all_ly_staffinfo)
1783
1784
1785 def option_parser ():
1786     p = ly.get_option_parser(usage=_ ("musicxml2ly [options] FILE.xml"),
1787                              version=('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
1788                                       +
1789 _ ("""This program is free software.  It is covered by the GNU General Public
1790 License and you are welcome to change it and/or distribute copies of it
1791 under certain conditions.  Invoke as `%s --warranty' for more
1792 information.""") % 'lilypond'
1793 + """
1794 Copyright (c) 2005--2007 by
1795     Han-Wen Nienhuys <hanwen@xs4all.nl>,
1796     Jan Nieuwenhuizen <janneke@gnu.org> and
1797     Reinhold Kainhofer <reinhold@kainhofer.com>
1798 """),
1799                              description=_ ("Convert %s to LilyPond input.") % 'MusicXML' + "\n")
1800     p.add_option ('-v', '--verbose',
1801                   action="store_true",
1802                   dest='verbose',
1803                   help=_ ("be verbose"))
1804
1805     p.add_option ('', '--lxml',
1806                   action="store_true",
1807                   default=False,
1808                   dest="use_lxml",
1809                   help=_ ("Use lxml.etree; uses less memory and cpu time."))
1810
1811     p.add_option ('-z', '--compressed',
1812                   action = "store_true",
1813                   dest = 'compressed',
1814                   default = False,
1815                   help = _ ("Input file is a zip-compressed MusicXML file."))
1816
1817     p.add_option ('-r', '--relative',
1818                   action = "store_true",
1819                   dest = "relative",
1820                   help = _ ("Convert pitches in relative mode."))
1821
1822     p.add_option ('-l', '--language',
1823                   action = "store",
1824                   help = _ ("Use a different language file, e.g. 'deutsch' for deutsch.ly."))
1825
1826     p.add_option ('--no-articulation-directions', '--nd',
1827                   action = "store_false",
1828                   default = True,
1829                   dest = "convert_directions",
1830                   help = _ ("Do not convert directions (^, _ or -) for articulations."))
1831
1832     p.add_option ('-o', '--output',
1833                   metavar=_ ("FILE"),
1834                   action="store",
1835                   default=None,
1836                   type='string',
1837                   dest='output_name',
1838                   help=_ ("set output filename to FILE"))
1839     p.add_option_group ('bugs',
1840                         description=(_ ("Report bugs via")
1841                                      + ''' http://post.gmane.org/post.php'''
1842                                      '''?group=gmane.comp.gnu.lilypond.bugs\n'''))
1843     return p
1844
1845 def music_xml_voice_name_to_lily_name (part_id, name):
1846     str = "Part%sVoice%s" % (part_id, name)
1847     return musicxml_id_to_lily (str)
1848
1849 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
1850     str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
1851     return musicxml_id_to_lily (str)
1852
1853 def print_voice_definitions (printer, part_list, voices):
1854     for part in part_list:
1855         part_id = part.id
1856         nv_dict = voices.get (part_id, {})
1857         for (name, voice) in nv_dict.items ():
1858             k = music_xml_voice_name_to_lily_name (part_id, name)
1859             printer.dump ('%s = ' % k)
1860             voice.ly_voice.print_ly (printer)
1861             printer.newline()
1862             for l in voice.lyrics_order:
1863                 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
1864                 printer.dump ('%s = ' %lname )
1865                 voice.lyrics_dict[l].print_ly (printer)
1866                 printer.newline()
1867
1868
1869 def uniq_list (l):
1870     return dict ([(elt,1) for elt in l]).keys ()
1871
1872 # format the information about the staff in the form
1873 #     [staffid,
1874 #         [
1875 #            [voiceid1, [lyricsid11, lyricsid12,...] ...],
1876 #            [voiceid2, [lyricsid21, lyricsid22,...] ...],
1877 #            ...
1878 #         ]
1879 #     ]
1880 # raw_voices is of the form [(voicename, lyricsids)*]
1881 def format_staff_info (part_id, staff_id, raw_voices):
1882     voices = []
1883     for (v, lyricsids) in raw_voices:
1884         voice_name = music_xml_voice_name_to_lily_name (part_id, v)
1885         voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
1886                    for l in lyricsids]
1887         voices.append ([voice_name, voice_lyrics])
1888     return [staff_id, voices]
1889
1890 def update_score_setup (score_structure, part_list, voices):
1891
1892     for part_definition in part_list:
1893         part_id = part_definition.id
1894         nv_dict = voices.get (part_id)
1895         if not nv_dict:
1896             error_message ('unknown part in part-list: %s' % part_id)
1897             continue
1898
1899         staves = reduce (lambda x,y: x+ y,
1900                 [voice.voicedata._staves.keys ()
1901                  for voice in nv_dict.values ()],
1902                 [])
1903         staves_info = []
1904         if len (staves) > 1:
1905             staves_info = []
1906             staves = uniq_list (staves)
1907             staves.sort ()
1908             for s in staves:
1909                 thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1910                     for (voice_name, voice) in nv_dict.items ()
1911                     if voice.voicedata._start_staff == s]
1912                 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
1913         else:
1914             thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1915                 for (voice_name, voice) in nv_dict.items ()]
1916             staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
1917         score_structure.set_part_information (part_id, staves_info)
1918
1919 def print_ly_preamble (printer, filename):
1920     printer.dump_version ()
1921     printer.print_verbatim ('%% automatically converted from %s\n' % filename)
1922
1923 def print_ly_additional_definitions (printer, filename):
1924     if needed_additional_definitions:
1925         printer.newline ()
1926         printer.print_verbatim ('%% additional definitions required by the score:')
1927         printer.newline ()
1928     for a in set(needed_additional_definitions):
1929         printer.print_verbatim (additional_definitions.get (a, ''))
1930         printer.newline ()
1931     printer.newline ()
1932
1933 # Read in the tree from the given I/O object (either file or string) and
1934 # demarshall it using the classes from the musicxml.py file
1935 def read_xml (io_object, use_lxml):
1936     if use_lxml:
1937         import lxml.etree
1938         tree = lxml.etree.parse (io_object)
1939         mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
1940         return mxl_tree
1941     else:
1942         from xml.dom import minidom, Node
1943         doc = minidom.parse(io_object)
1944         node = doc.documentElement
1945         return musicxml.minidom_demarshal_node (node)
1946     return None
1947
1948
1949 def read_musicxml (filename, compressed, use_lxml):
1950     raw_string = None
1951     if compressed:
1952         progress ("Input file %s is compressed, extracting raw MusicXML data" % filename)
1953         z = zipfile.ZipFile (filename, "r")
1954         container_xml = z.read ("META-INF/container.xml")
1955         if not container_xml:
1956             return None
1957         container = read_xml (StringIO.StringIO (container_xml), use_lxml)
1958         if not container:
1959             return None
1960         rootfiles = container.get_maybe_exist_named_child ('rootfiles')
1961         if not rootfiles:
1962             return None
1963         rootfile_list = rootfiles.get_named_children ('rootfile')
1964         mxml_file = None
1965         if len (rootfile_list) > 0:
1966             mxml_file = getattr (rootfile_list[0], 'full-path', None)
1967         if mxml_file:
1968             raw_string = z.read (mxml_file)
1969
1970     io_object = filename
1971     if raw_string:
1972         io_object = StringIO.StringIO (raw_string)
1973
1974     return read_xml (io_object, use_lxml)
1975
1976
1977 def convert (filename, options):
1978     progress ("Reading MusicXML from %s ..." % filename)
1979
1980     tree = read_musicxml (filename, options.compressed, options.use_lxml)
1981     parts = tree.get_typed_children (musicxml.Part)
1982     (voices, staff_info) = get_all_voices (parts)
1983
1984     score_structure = None
1985     mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
1986     if mxl_pl:
1987         score_structure = extract_score_layout (mxl_pl, staff_info)
1988         part_list = mxl_pl.get_named_children ("score-part")
1989
1990     # score information is contained in the <work>, <identification> or <movement-title> tags
1991     score_information = extract_score_information (tree)
1992     layout_information = extract_layout_information (tree)
1993     update_score_setup (score_structure, part_list, voices)
1994
1995     if not options.output_name:
1996         options.output_name = os.path.basename (filename)
1997         options.output_name = os.path.splitext (options.output_name)[0]
1998     elif re.match (".*\.ly", options.output_name):
1999         options.output_name = os.path.splitext (options.output_name)[0]
2000
2001
2002     defs_ly_name = options.output_name + '-defs.ly'
2003     driver_ly_name = options.output_name + '.ly'
2004
2005     printer = musicexp.Output_printer()
2006     progress ("Output to `%s'" % defs_ly_name)
2007     printer.set_file (codecs.open (defs_ly_name, 'wb', encoding='utf-8'))
2008
2009     print_ly_preamble (printer, filename)
2010     print_ly_additional_definitions (printer, filename)
2011     if score_information:
2012         score_information.print_ly (printer)
2013     if layout_information:
2014         layout_information.print_ly (printer)
2015     print_voice_definitions (printer, part_list, voices)
2016
2017     printer.close ()
2018
2019
2020     progress ("Output to `%s'" % driver_ly_name)
2021     printer = musicexp.Output_printer()
2022     printer.set_file (codecs.open (driver_ly_name, 'wb', encoding='utf-8'))
2023     print_ly_preamble (printer, filename)
2024     printer.dump (r'\include "%s"' % os.path.basename (defs_ly_name))
2025     score_structure.print_ly (printer)
2026     printer.newline ()
2027
2028     return voices
2029
2030 def get_existing_filename_with_extension (filename, ext):
2031     if os.path.exists (filename):
2032         return filename
2033     newfilename = filename + "." + ext
2034     if os.path.exists (newfilename):
2035         return newfilename;
2036     newfilename = filename + ext
2037     if os.path.exists (newfilename):
2038         return newfilename;
2039     return ''
2040
2041 def main ():
2042     opt_parser = option_parser()
2043
2044     global options
2045     (options, args) = opt_parser.parse_args ()
2046     if not args:
2047         opt_parser.print_usage()
2048         sys.exit (2)
2049
2050     if options.language:
2051         musicexp.set_pitch_language (options.language)
2052         needed_additional_definitions.append (options.language)
2053         additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
2054
2055     # Allow the user to leave out the .xml or xml on the filename
2056     filename = get_existing_filename_with_extension (args[0], "xml")
2057     if not filename:
2058         filename = get_existing_filename_with_extension (args[0], "mxl")
2059         options.compressed = True
2060     if filename and os.path.exists (filename):
2061         voices = convert (filename, options)
2062     else:
2063         progress ("Unable to find input file %s" % args[0])
2064
2065 if __name__ == '__main__':
2066     main()