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