scripts/musicxml2ly.py

   1 #!@TARGET_PYTHON@
   2 # -*- coding: utf-8 -*-
   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
  48   "tuplet-note-wrapper": """      % a formatter function, which is simply a wrapper around an existing
  49       % tuplet formatter function. It takes the value returned by the given
  50       % function and appends a note of given length.
  51   #(define-public ((tuplet-number::append-note-wrapper function note) grob)
  52     (let* ((txt (if function (function grob) #f)))
  53       (if txt
  54         (markup txt #:fontsize -5 #:note note UP)
  55         (markup #:fontsize -5 #:note note UP)
  56       )
  57     )
  58   )""",
  59
  60   "tuplet-non-default-denominator": """#(define ((tuplet-number::non-default-tuplet-denominator-text denominator) grob)
  61   (number->string (if denominator
  62                       denominator
  63                       (ly:event-property (event-cause grob) 'denominator))))
  64 """,
  65
  66   "tuplet-non-default-fraction": """#(define ((tuplet-number::non-default-tuplet-fraction-text denominator numerator) grob)
  67     (let* ((ev (event-cause grob))
  68            (den (if denominator denominator (ly:event-property ev 'denominator)))
  69            (num (if numerator numerator (ly:event-property ev 'numerator))))
  70        (format "~a:~a" den num)))
  71 """,
  72
  73   "compound-time-signature": """%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  74 % Formatting of (possibly complex) compound time signatures
  75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76
  77 #(define-public (insert-markups l m)
  78   (let* ((ll (reverse l)))
  79     (let join-markups ((markups (list (car ll)))
  80                        (remaining (cdr ll)))
  81       (if (pair? remaining)
  82         (join-markups (cons (car remaining) (cons m markups)) (cdr remaining))
  83         markups))))
  84
  85 % Use a centered-column inside a left-column, because the centered column
  86 % moves its reference point to the center, which the left-column undoes.
  87 % The center-column also aligns its contented centered, which is not undone...
  88 #(define-public (format-time-fraction time-sig-fraction)
  89   (let* ((revargs (reverse (map number->string time-sig-fraction)))
  90          (den (car revargs))
  91          (nums (reverse (cdr revargs))))
  92     (make-override-markup '(baseline-skip . 0)
  93       (make-number-markup
  94         (make-left-column-markup (list
  95           (make-center-column-markup (list
  96             (make-line-markup (insert-markups nums "+"))
  97             den))))))))
  98
  99 #(define-public (format-complex-compound-time time-sig)
 100   (let* ((sigs (map format-time-fraction time-sig)))
 101     (make-override-markup '(baseline-skip . 0)
 102       (make-number-markup
 103         (make-line-markup
 104           (insert-markups sigs (make-vcenter-markup "+")))))))
 105
 106 #(define-public (format-compound-time time-sig)
 107   (cond
 108     ((not (pair? time-sig)) (null-markup))
 109     ((pair? (car time-sig)) (format-complex-compound-time time-sig))
 110     (else (format-time-fraction time-sig))))
 111
 112
 113 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 % Measure length calculation of (possibly complex) compound time signatures
 115 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 116
 117 #(define-public (calculate-time-fraction time-sig-fraction)
 118   (let* ((revargs (reverse time-sig-fraction))
 119          (den (car revargs))
 120          (nums (cdr revargs)))
 121     (ly:make-moment (apply + nums) den)))
 122
 123 #(define-public (calculate-complex-compound-time time-sig)
 124   (let* ((sigs (map calculate-time-fraction time-sig)))
 125     (let add-moment ((moment ZERO-MOMENT)
 126                      (remaining sigs))
 127       (if (pair? remaining)
 128         (add-moment (ly:moment-add moment (car remaining)) (cdr remaining))
 129         moment))))
 130
 131 #(define-public (calculate-compound-measure-length time-sig)
 132   (cond
 133     ((not (pair? time-sig)) (ly:make-moment 4 4))
 134     ((pair? (car time-sig)) (calculate-complex-compound-time time-sig))
 135     (else (calculate-time-fraction time-sig))))
 136
 137
 138 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 139 % Base beat lenth
 140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 141
 142 #(define-public (calculate-compound-base-beat-full time-sig)
 143   (let* ((den (map last time-sig)))
 144     (apply max den)))
 145
 146 #(define-public (calculate-compound-base-beat time-sig)
 147   (ly:make-moment 1 (cond
 148     ((not (pair? time-sig)) 4)
 149     ((pair? (car time-sig)) (calculate-compound-base-beat-full time-sig))
 150     (else (calculate-compound-base-beat-full (list time-sig))))))
 151
 152
 153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 154 % The music function to set the complex time signature
 155 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 156
 157 compoundMeter =
 158 #(define-music-function (parser location args) (pair?)
 159   (let ((mlen (calculate-compound-measure-length args))
 160         (beat (calculate-compound-base-beat args)))
 161   #{
 162 \once \override Staff.TimeSignature #'stencil = #ly:text-interface::print
 163 \once \override Staff.TimeSignature #'text = #(format-compound-time $args)
 164 % \set Staff.beatGrouping = #(reverse (cdr (reverse $args)))
 165 \set Timing.measureLength = $mlen
 166 \set Timing.timeSignatureFraction = #(cons (ly:moment-main-numerator $mlen)
 167                                            (ly:moment-main-denominator $mlen))
 168 \set Timing.beatLength = $beat
 169
 170 % TODO: Implement beatGrouping and auto-beam-settings!!!
 171 #} ))
 172 """
 173 }
 174
 175 def round_to_two_digits (val):
 176     return round (val * 100) / 100
 177
 178 def extract_paper_information (tree):
 179     paper = musicexp.Paper ()
 180     defaults = tree.get_maybe_exist_named_child ('defaults')
 181     if not defaults:
 182         return None
 183     tenths = -1
 184     scaling = defaults.get_maybe_exist_named_child ('scaling')
 185     if scaling:
 186         mm = scaling.get_named_child ('millimeters')
 187         mm = string.atof (mm.get_text ())
 188         tn = scaling.get_maybe_exist_named_child ('tenths')
 189         tn = string.atof (tn.get_text ())
 190         tenths = mm / tn
 191         paper.global_staff_size = mm * 72.27 / 25.4
 192     # We need the scaling (i.e. the size of staff tenths for everything!
 193     if tenths < 0:
 194         return None
 195
 196     def from_tenths (txt):
 197         return round_to_two_digits (string.atof (txt) * tenths / 10)
 198     def set_paper_variable (varname, parent, element_name):
 199         el = parent.get_maybe_exist_named_child (element_name)
 200         if el: # Convert to cm from tenths
 201             setattr (paper, varname, from_tenths (el.get_text ()))
 202
 203     pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
 204     if pagelayout:
 205         # TODO: How can one have different margins for even and odd pages???
 206         set_paper_variable ("page_height", pagelayout, 'page-height')
 207         set_paper_variable ("page_width", pagelayout, 'page-width')
 208
 209         pmargins = pagelayout.get_named_children ('page-margins')
 210         for pm in pmargins:
 211             set_paper_variable ("left_margin", pm, 'left-margin')
 212             set_paper_variable ("right_margin", pm, 'right-margin')
 213             set_paper_variable ("bottom_margin", pm, 'bottom-margin')
 214             set_paper_variable ("top_margin", pm, 'top-margin')
 215
 216     systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
 217     if systemlayout:
 218         sl = systemlayout.get_maybe_exist_named_child ('system-margins')
 219         if sl:
 220             set_paper_variable ("system_left_margin", sl, 'left-margin')
 221             set_paper_variable ("system_right_margin", sl, 'right-margin')
 222         set_paper_variable ("system_distance", systemlayout, 'system-distance')
 223         set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
 224
 225     stafflayout = defaults.get_named_children ('staff-layout')
 226     for sl in stafflayout:
 227         nr = getattr (sl, 'number', 1)
 228         dist = sl.get_named_child ('staff-distance')
 229         #TODO: the staff distance needs to be set in the Staff context!!!
 230
 231     # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
 232     appearance = defaults.get_named_child ('appearance')
 233     if appearance:
 234         lws = appearance.get_named_children ('line-width')
 235         for lw in lws:
 236             # Possible types are: beam, bracket, dashes,
 237             #    enclosure, ending, extend, heavy barline, leger,
 238             #    light barline, octave shift, pedal, slur middle, slur tip,
 239             #    staff, stem, tie middle, tie tip, tuplet bracket, and wedge
 240             tp = lw.type
 241             w = from_tenths (lw.get_text  ())
 242             # TODO: Do something with these values!
 243         nss = appearance.get_named_children ('note-size')
 244         for ns in nss:
 245             # Possible types are: cue, grace and large
 246             tp = ns.type
 247             sz = from_tenths (ns.get_text ())
 248             # TODO: Do something with these values!
 249         # <other-appearance> elements have no specified meaning
 250
 251     rawmusicfont = defaults.get_named_child ('music-font')
 252     if rawmusicfont:
 253         # TODO: Convert the font
 254         pass
 255     rawwordfont = defaults.get_named_child ('word-font')
 256     if rawwordfont:
 257         # TODO: Convert the font
 258         pass
 259     rawlyricsfonts = defaults.get_named_children ('lyric-font')
 260     for lyricsfont in rawlyricsfonts:
 261         # TODO: Convert the font
 262         pass
 263
 264     return paper
 265
 266
 267
 268 # score information is contained in the <work>, <identification> or <movement-title> tags
 269 # extract those into a hash, indexed by proper lilypond header attributes
 270 def extract_score_information (tree):
 271     header = musicexp.Header ()
 272     def set_if_exists (field, value):
 273         if value:
 274             header.set_field (field, musicxml.escape_ly_output_string (value))
 275
 276     movement_title = tree.get_maybe_exist_named_child ('movement-title')
 277     if movement_title:
 278         set_if_exists ('title', movement_title.get_text ())
 279     work = tree.get_maybe_exist_named_child ('work')
 280     if work:
 281         # Overwrite the title from movement-title with work->title
 282         set_if_exists ('title', work.get_work_title ())
 283         set_if_exists ('worknumber', work.get_work_number ())
 284         set_if_exists ('opus', work.get_opus ())
 285
 286     identifications = tree.get_named_children ('identification')
 287     for ids in identifications:
 288         set_if_exists ('copyright', ids.get_rights ())
 289         set_if_exists ('composer', ids.get_composer ())
 290         set_if_exists ('arranger', ids.get_arranger ())
 291         set_if_exists ('editor', ids.get_editor ())
 292         set_if_exists ('poet', ids.get_poet ())
 293
 294         set_if_exists ('tagline', ids.get_encoding_software ())
 295         set_if_exists ('encodingsoftware', ids.get_encoding_software ())
 296         set_if_exists ('encodingdate', ids.get_encoding_date ())
 297         set_if_exists ('encoder', ids.get_encoding_person ())
 298         set_if_exists ('encodingdescription', ids.get_encoding_description ())
 299
 300         set_if_exists ('texidoc', ids.get_file_description ());
 301
 302         # Finally, apply the required compatibility modes
 303         # Some applications created wrong MusicXML files, so we need to
 304         # apply some compatibility mode, e.g. ignoring some features/tags
 305         # in those files
 306         software = ids.get_encoding_software_list ()
 307
 308         # Case 1: "Sibelius 5.1" with the "Dolet 3.4 for Sibelius" plugin
 309         #         is missing all beam ends => ignore all beaming information
 310         ignore_beaming_software = {
 311             "Dolet 3.5 for Sibelius": "Dolet 3.5 for Sibelius",
 312             "Dolet 3.4 for Sibelius": "Dolet 3.4 for Sibelius",
 313             "Dolet 3.3 for Sibelius": "Dolet 3.3 for Sibelius",
 314             "Dolet 3.2 for Sibelius": "Dolet 3.2 for Sibelius",
 315             "Dolet 3.1 for Sibelius": "Dolet 3.1 for Sibelius",
 316             "Dolet for Sibelius 1.3": "Dolet for Sibelius 1.3",
 317             "Noteworthy Composer": "Noteworthy Composer's nwc2xm[",
 318         }
 319         for s in software:
 320             app_description = ignore_beaming_software.get (s, False);
 321             if app_description:
 322                 conversion_settings.ignore_beaming = True
 323                 progress (_ ("Encountered file created by %s, containing wrong beaming information. All beaming information in the MusicXML file will be ignored") % app_description)
 324
 325     # TODO: Check for other unsupported features
 326     return header
 327
 328 class PartGroupInfo:
 329     def __init__ (self):
 330         self.start = {}
 331         self.end = {}
 332     def is_empty (self):
 333         return len (self.start) + len (self.end) == 0
 334     def add_start (self, g):
 335         self.start[getattr (g, 'number', "1")] = g
 336     def add_end (self, g):
 337         self.end[getattr (g, 'number', "1")] = g
 338     def print_ly (self, printer):
 339         error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
 340     def ly_expression (self):
 341         error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
 342         return ''
 343
 344 def staff_attributes_to_string_tunings (mxl_attr):
 345     details = mxl_attr.get_maybe_exist_named_child ('staff-details')
 346     if not details:
 347         return []
 348     lines = 6
 349     staff_lines = details.get_maybe_exist_named_child ('staff-lines')
 350     if staff_lines:
 351         lines = string.atoi (staff_lines.get_text ())
 352
 353     tunings = [0]*lines
 354     staff_tunings = details.get_named_children ('staff-tuning')
 355     for i in staff_tunings:
 356         p = musicexp.Pitch()
 357         line = 0
 358         try:
 359             line = string.atoi (i.line) - 1
 360         except ValueError:
 361             pass
 362         tunings[line] = p
 363
 364         step = i.get_named_child (u'tuning-step')
 365         step = step.get_text ().strip ()
 366         p.step = musicxml_step_to_lily (step)
 367
 368         octave = i.get_named_child (u'tuning-octave')
 369         octave = octave.get_text ().strip ()
 370         p.octave = int (octave) - 4
 371
 372         alter = i.get_named_child (u'tuning-alter')
 373         if alter:
 374             p.alteration = int (alter.get_text ().strip ())
 375     # lilypond seems to use the opposite ordering than MusicXML...
 376     tunings.reverse ()
 377
 378     return tunings
 379
 380
 381 def staff_attributes_to_lily_staff (mxl_attr):
 382     if not mxl_attr:
 383         return musicexp.Staff ()
 384
 385     (staff_id, attributes) = mxl_attr.items ()[0]
 386
 387     # distinguish by clef:
 388     # percussion (percussion and rhythmic), tab, and everything else
 389     clef_sign = None
 390     clef = attributes.get_maybe_exist_named_child ('clef')
 391     if clef:
 392         sign = clef.get_maybe_exist_named_child ('sign')
 393         if sign:
 394             clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
 395
 396     lines = 5
 397     details = attributes.get_named_children ('staff-details')
 398     for d in details:
 399         staff_lines = d.get_maybe_exist_named_child ('staff-lines')
 400         if staff_lines:
 401             lines = string.atoi (staff_lines.get_text ())
 402
 403     staff = None
 404     if clef_sign == "percussion" and lines == 1:
 405         staff = musicexp.RhythmicStaff ()
 406     elif clef_sign == "percussion":
 407         staff = musicexp.DrumStaff ()
 408         # staff.drum_style_table = ???
 409     elif clef_sign == "tab":
 410         staff = musicexp.TabStaff ()
 411         staff.string_tunings = staff_attributes_to_string_tunings (attributes)
 412         # staff.tablature_format = ???
 413     else:
 414         # TODO: Handle case with lines <> 5!
 415         staff = musicexp.Staff ()
 416
 417     return staff
 418
 419
 420 def extract_score_structure (part_list, staffinfo):
 421     score = musicexp.Score ()
 422     structure = musicexp.StaffGroup (None)
 423     score.set_contents (structure)
 424
 425     if not part_list:
 426         return structure
 427
 428     def read_score_part (el):
 429         if not isinstance (el, musicxml.Score_part):
 430             return
 431         # Depending on the attributes of the first measure, we create different
 432         # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
 433         staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
 434         if not staff:
 435             return None
 436         staff.id = el.id
 437         partname = el.get_maybe_exist_named_child ('part-name')
 438         # Finale gives unnamed parts the name "MusicXML Part" automatically!
 439         if partname and partname.get_text() != "MusicXML Part":
 440             staff.instrument_name = partname.get_text ()
 441         if el.get_maybe_exist_named_child ('part-abbreviation'):
 442             staff.short_instrument_name = el.get_maybe_exist_named_child ('part-abbreviation').get_text ()
 443         # TODO: Read in the MIDI device / instrument
 444         return staff
 445
 446     def read_score_group (el):
 447         if not isinstance (el, musicxml.Part_group):
 448             return
 449         group = musicexp.StaffGroup ()
 450         if hasattr (el, 'number'):
 451             id = el.number
 452             group.id = id
 453             #currentgroups_dict[id] = group
 454             #currentgroups.append (id)
 455         if el.get_maybe_exist_named_child ('group-name'):
 456             group.instrument_name = el.get_maybe_exist_named_child ('group-name').get_text ()
 457         if el.get_maybe_exist_named_child ('group-abbreviation'):
 458             group.short_instrument_name = el.get_maybe_exist_named_child ('group-abbreviation').get_text ()
 459         if el.get_maybe_exist_named_child ('group-symbol'):
 460             group.symbol = el.get_maybe_exist_named_child ('group-symbol').get_text ()
 461         if el.get_maybe_exist_named_child ('group-barline'):
 462             group.spanbar = el.get_maybe_exist_named_child ('group-barline').get_text ()
 463         return group
 464
 465
 466     parts_groups = part_list.get_all_children ()
 467
 468     # the start/end group tags are not necessarily ordered correctly and groups
 469     # might even overlap, so we can't go through the children sequentially!
 470
 471     # 1) Replace all Score_part objects by their corresponding Staff objects,
 472     #    also collect all group start/stop points into one PartGroupInfo object
 473     staves = []
 474     group_info = PartGroupInfo ()
 475     for el in parts_groups:
 476         if isinstance (el, musicxml.Score_part):
 477             if not group_info.is_empty ():
 478                 staves.append (group_info)
 479                 group_info = PartGroupInfo ()
 480             staff = read_score_part (el)
 481             if staff:
 482                 staves.append (staff)
 483         elif isinstance (el, musicxml.Part_group):
 484             if el.type == "start":
 485                 group_info.add_start (el)
 486             elif el.type == "stop":
 487                 group_info.add_end (el)
 488     if not group_info.is_empty ():
 489         staves.append (group_info)
 490
 491     # 2) Now, detect the groups:
 492     group_starts = []
 493     pos = 0
 494     while pos < len (staves):
 495         el = staves[pos]
 496         if isinstance (el, PartGroupInfo):
 497             prev_start = 0
 498             if len (group_starts) > 0:
 499                 prev_start = group_starts[-1]
 500             elif len (el.end) > 0: # no group to end here
 501                 el.end = {}
 502             if len (el.end) > 0: # closes an existing group
 503                 ends = el.end.keys ()
 504                 prev_started = staves[prev_start].start.keys ()
 505                 grpid = None
 506                 intersection = filter(lambda x:x in ends, prev_started)
 507                 if len (intersection) > 0:
 508                     grpid = intersection[0]
 509                 else:
 510                     # Close the last started group
 511                     grpid = staves[prev_start].start.keys () [0]
 512                     # Find the corresponding closing tag and remove it!
 513                     j = pos + 1
 514                     foundclosing = False
 515                     while j < len (staves) and not foundclosing:
 516                         if isinstance (staves[j], PartGroupInfo) and staves[j].end.has_key (grpid):
 517                             foundclosing = True
 518                             del staves[j].end[grpid]
 519                             if staves[j].is_empty ():
 520                                 del staves[j]
 521                         j += 1
 522                 grpobj = staves[prev_start].start[grpid]
 523                 group = read_score_group (grpobj)
 524                 # remove the id from both the start and end
 525                 if el.end.has_key (grpid):
 526                     del el.end[grpid]
 527                 del staves[prev_start].start[grpid]
 528                 if el.is_empty ():
 529                     del staves[pos]
 530                 # replace the staves with the whole group
 531                 for j in staves[(prev_start + 1):pos]:
 532                     group.append_staff (j)
 533                 del staves[(prev_start + 1):pos]
 534                 staves.insert (prev_start + 1, group)
 535                 # reset pos so that we continue at the correct position
 536                 pos = prev_start
 537                 # remove an empty start group
 538                 if staves[prev_start].is_empty ():
 539                     del staves[prev_start]
 540                     group_starts.remove (prev_start)
 541                     pos -= 1
 542             elif len (el.start) > 0: # starts new part groups
 543                 group_starts.append (pos)
 544         pos += 1
 545
 546     if len (staves) == 1:
 547         return staves[0]
 548     for i in staves:
 549         structure.append_staff (i)
 550     return score
 551
 552
 553 def musicxml_duration_to_lily (mxl_note):
 554     # if the note has no Type child, then that method returns None. In that case,
 555     # use the <duration> tag instead. If that doesn't exist, either -> Error
 556     dur = mxl_note.get_duration_info ()
 557     if dur:
 558         d = musicexp.Duration ()
 559         d.duration_log = dur[0]
 560         d.dots = dur[1]
 561         # Grace notes by specification have duration 0, so no time modification
 562         # factor is possible. It even messes up the output with *0/1
 563         if not mxl_note.get_maybe_exist_typed_child (musicxml.Grace):
 564             d.factor = mxl_note._duration / d.get_length ()
 565         return d
 566
 567     else:
 568         if mxl_note._duration > 0:
 569             return rational_to_lily_duration (mxl_note._duration)
 570         else:
 571             mxl_note.message (_ ("Encountered note at %s without type and duration (=%s)") % (mxl_note.start, mxl_note._duration) )
 572             return None
 573
 574
 575 def rational_to_lily_duration (rational_len):
 576     d = musicexp.Duration ()
 577
 578     rational_len.normalize_self ()
 579     d_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)
 580
 581     # Duration of the form 1/2^n or 3/2^n can be converted to a simple lilypond duration
 582     if (d_log >= 0 and rational_len.numerator() in (1,3,5,7) ):
 583         # account for the dots!
 584         d.dots = (rational_len.numerator()-1)/2
 585         d.duration_log = d_log - d.dots
 586     elif (d_log >= 0):
 587         d.duration_log = d_log
 588         d.factor = Rational (rational_len.numerator ())
 589     else:
 590         error_message (_ ("Encountered rational duration with denominator %s, "
 591                        "unable to convert to lilypond duration") %
 592                        rational_len.denominator ())
 593         # TODO: Test the above error message
 594         return None
 595
 596     return d
 597
 598 def musicxml_partial_to_lily (partial_len):
 599     if partial_len > 0:
 600         p = musicexp.Partial ()
 601         p.partial = rational_to_lily_duration (partial_len)
 602         return p
 603     else:
 604         return Null
 605
 606 # Detect repeats and alternative endings in the chord event list (music_list)
 607 # and convert them to the corresponding musicexp objects, containing nested
 608 # music
 609 def group_repeats (music_list):
 610     repeat_replaced = True
 611     music_start = 0
 612     i = 0
 613     # Walk through the list of expressions, looking for repeat structure
 614     # (repeat start/end, corresponding endings). If we find one, try to find the
 615     # last event of the repeat, replace the whole structure and start over again.
 616     # For nested repeats, as soon as we encounter another starting repeat bar,
 617     # treat that one first, and start over for the outer repeat.
 618     while repeat_replaced and i < 100:
 619         i += 1
 620         repeat_start = -1  # position of repeat start / end
 621         repeat_end = -1 # position of repeat start / end
 622         repeat_times = 0
 623         ending_start = -1 # position of current ending start
 624         endings = [] # list of already finished endings
 625         pos = 0
 626         last = len (music_list) - 1
 627         repeat_replaced = False
 628         final_marker = 0
 629         while pos < len (music_list) and not repeat_replaced:
 630             e = music_list[pos]
 631             repeat_finished = False
 632             if isinstance (e, RepeatMarker):
 633                 if not repeat_times and e.times:
 634                     repeat_times = e.times
 635                 if e.direction == -1:
 636                     if repeat_end >= 0:
 637                         repeat_finished = True
 638                     else:
 639                         repeat_start = pos
 640                         repeat_end = -1
 641                         ending_start = -1
 642                         endings = []
 643                 elif e.direction == 1:
 644                     if repeat_start < 0:
 645                         repeat_start = 0
 646                     if repeat_end < 0:
 647                         repeat_end = pos
 648                     final_marker = pos
 649             elif isinstance (e, EndingMarker):
 650                 if e.direction == -1:
 651                     if repeat_start < 0:
 652                         repeat_start = 0
 653                     if repeat_end < 0:
 654                         repeat_end = pos
 655                     ending_start = pos
 656                 elif e.direction == 1:
 657                     if ending_start < 0:
 658                         ending_start = 0
 659                     endings.append ([ending_start, pos])
 660                     ending_start = -1
 661                     final_marker = pos
 662             elif not isinstance (e, musicexp.BarLine):
 663                 # As soon as we encounter an element when repeat start and end
 664                 # is set and we are not inside an alternative ending,
 665                 # this whole repeat structure is finished => replace it
 666                 if repeat_start >= 0 and repeat_end > 0 and ending_start < 0:
 667                     repeat_finished = True
 668
 669             # Finish off all repeats without explicit ending bar (e.g. when
 670             # we convert only one page of a multi-page score with repeats)
 671             if pos == last and repeat_start >= 0:
 672                 repeat_finished = True
 673                 final_marker = pos
 674                 if repeat_end < 0:
 675                     repeat_end = pos
 676                 if ending_start >= 0:
 677                     endings.append ([ending_start, pos])
 678                     ending_start = -1
 679
 680             if repeat_finished:
 681                 # We found the whole structure replace it!
 682                 r = musicexp.RepeatedMusic ()
 683                 if repeat_times <= 0:
 684                     repeat_times = 2
 685                 r.repeat_count = repeat_times
 686                 # don't erase the first element for "implicit" repeats (i.e. no
 687                 # starting repeat bars at the very beginning)
 688                 start = repeat_start+1
 689                 if repeat_start == music_start:
 690                     start = music_start
 691                 r.set_music (music_list[start:repeat_end])
 692                 for (start, end) in endings:
 693                     s = musicexp.SequentialMusic ()
 694                     s.elements = music_list[start+1:end]
 695                     r.add_ending (s)
 696                 del music_list[repeat_start:final_marker+1]
 697                 music_list.insert (repeat_start, r)
 698                 repeat_replaced = True
 699             pos += 1
 700         # TODO: Implement repeats until the end without explicit ending bar
 701     return music_list
 702
 703
 704 # Extract the settings for tuplets from the <notations><tuplet> and the
 705 # <time-modification> elements of the note:
 706 def musicxml_tuplet_to_lily (tuplet_elt, time_modification):
 707     tsm = musicexp.TimeScaledMusic ()
 708     fraction = (1,1)
 709     if time_modification:
 710         fraction = time_modification.get_fraction ()
 711     tsm.numerator = fraction[0]
 712     tsm.denominator  = fraction[1]
 713
 714
 715     normal_type = tuplet_elt.get_normal_type ()
 716     if not normal_type and time_modification:
 717         normal_type = time_modification.get_normal_type ()
 718     if not normal_type and time_modification:
 719         note = time_modification.get_parent ()
 720         if note:
 721             normal_type = note.get_duration_info ()
 722     if normal_type:
 723         normal_note = musicexp.Duration ()
 724         (normal_note.duration_log, normal_note.dots) = normal_type
 725         tsm.normal_type = normal_note
 726
 727     actual_type = tuplet_elt.get_actual_type ()
 728     if actual_type:
 729         actual_note = musicexp.Duration ()
 730         (actual_note.duration_log, actual_note.dots) = actual_type
 731         tsm.actual_type = actual_note
 732
 733     # Obtain non-default nrs of notes from the tuplet object!
 734     tsm.display_numerator = tuplet_elt.get_normal_nr ()
 735     tsm.display_denominator = tuplet_elt.get_actual_nr ()
 736
 737
 738     if hasattr (tuplet_elt, 'bracket') and tuplet_elt.bracket == "no":
 739         tsm.display_bracket = None
 740     elif hasattr (tuplet_elt, 'line-shape') and getattr (tuplet_elt, 'line-shape') == "curved":
 741         tsm.display_bracket = "curved"
 742     else:
 743         tsm.display_bracket = "bracket"
 744
 745     display_values = {"none": None, "actual": "actual", "both": "both"}
 746     if hasattr (tuplet_elt, "show-number"):
 747         tsm.display_number = display_values.get (getattr (tuplet_elt, "show-number"), "actual")
 748
 749     if hasattr (tuplet_elt, "show-type"):
 750         tsm.display_type = display_values.get (getattr (tuplet_elt, "show-type"), None)
 751
 752     return tsm
 753
 754
 755 def group_tuplets (music_list, events):
 756
 757
 758     """Collect Musics from
 759     MUSIC_LIST demarcated by EVENTS_LIST in TimeScaledMusic objects.
 760     """
 761
 762
 763     indices = []
 764     brackets = {}
 765
 766     j = 0
 767     for (ev_chord, tuplet_elt, time_modification) in events:
 768         while (j < len (music_list)):
 769             if music_list[j] == ev_chord:
 770                 break
 771             j += 1
 772         nr = 0
 773         if hasattr (tuplet_elt, 'number'):
 774             nr = getattr (tuplet_elt, 'number')
 775         if tuplet_elt.type == 'start':
 776             tuplet_object = musicxml_tuplet_to_lily (tuplet_elt, time_modification)
 777             tuplet_info = [j, None, tuplet_object]
 778             indices.append (tuplet_info)
 779             brackets[nr] = tuplet_info
 780         elif tuplet_elt.type == 'stop':
 781             bracket_info = brackets.get (nr, None)
 782             if bracket_info:
 783                 bracket_info[1] = j # Set the ending position to j
 784                 del brackets[nr]
 785
 786     new_list = []
 787     last = 0
 788     for (i1, i2, tsm) in indices:
 789         if i1 > i2:
 790             continue
 791
 792         new_list.extend (music_list[last:i1])
 793         seq = musicexp.SequentialMusic ()
 794         last = i2 + 1
 795         seq.elements = music_list[i1:last]
 796
 797         tsm.element = seq
 798
 799         new_list.append (tsm)
 800         #TODO: Handle nested tuplets!!!!
 801
 802     new_list.extend (music_list[last:])
 803     return new_list
 804
 805
 806 def musicxml_clef_to_lily (attributes):
 807     change = musicexp.ClefChange ()
 808     (change.type, change.position, change.octave) = attributes.get_clef_information ()
 809     return change
 810
 811 def musicxml_time_to_lily (attributes):
 812     sig = attributes.get_time_signature ()
 813     if not sig:
 814         return None
 815     change = musicexp.TimeSignatureChange()
 816     change.fractions = sig
 817     if (len(sig) != 2) or isinstance (sig[0], list):
 818         needed_additional_definitions.append ("compound-time-signature")
 819
 820     time_elm = attributes.get_maybe_exist_named_child ('time')
 821     if time_elm and hasattr (time_elm, 'symbol'):
 822         change.style = { 'single-number': "'single-digit",
 823                          'cut': None,
 824                          'common': None,
 825                          'normal': "'()"}.get (time_elm.symbol, "'()")
 826     else:
 827         change.style = "'()"
 828
 829     # TODO: Handle senza-misura measures
 830     # TODO: Handle hidden time signatures (print-object="no")
 831     # TODO: What shall we do if the symbol clashes with the sig? e.g. "cut"
 832     #       with 3/8 or "single-number" with (2+3)/8 or 3/8+2/4?
 833
 834     return change
 835
 836 def musicxml_key_to_lily (attributes):
 837     key_sig = attributes.get_key_signature ()
 838     if not key_sig or not (isinstance (key_sig, list) or isinstance (key_sig, tuple)):
 839         error_message (_ ("Unable to extract key signature!"))
 840         return None
 841
 842     change = musicexp.KeySignatureChange()
 843
 844     if len (key_sig) == 2 and not isinstance (key_sig[0], list):
 845         # standard key signature, (fifths, mode)
 846         (fifths, mode) = key_sig
 847         change.mode = mode
 848
 849         start_pitch  = musicexp.Pitch ()
 850         start_pitch.octave = 0
 851         try:
 852             (n,a) = {
 853                 'major'     : (0,0),
 854                 'minor'     : (5,0),
 855                 'ionian'    : (0,0),
 856                 'dorian'    : (1,0),
 857                 'phrygian'  : (2,0),
 858                 'lydian'    : (3,0),
 859                 'mixolydian': (4,0),
 860                 'aeolian'   : (5,0),
 861                 'locrian'   : (6,0),
 862                 }[mode]
 863             start_pitch.step = n
 864             start_pitch.alteration = a
 865         except  KeyError:
 866             error_message (_ ("unknown mode %s, expecting 'major' or 'minor' "
 867                 "or a church mode!") % mode)
 868
 869         fifth = musicexp.Pitch()
 870         fifth.step = 4
 871         if fifths < 0:
 872             fifths *= -1
 873             fifth.step *= -1
 874             fifth.normalize ()
 875         for x in range (fifths):
 876             start_pitch = start_pitch.transposed (fifth)
 877         change.tonic = start_pitch
 878
 879     else:
 880         # Non-standard key signature of the form [[step,alter<,octave>],...]
 881         change.non_standard_alterations = key_sig
 882     return change
 883
 884 def musicxml_transpose_to_lily (attributes):
 885     transpose = attributes.get_transposition ()
 886     if not transpose:
 887         return None
 888
 889     shift = musicexp.Pitch ()
 890     octave_change = transpose.get_maybe_exist_named_child ('octave-change')
 891     if octave_change:
 892         shift.octave = string.atoi (octave_change.get_text ())
 893     chromatic_shift = string.atoi (transpose.get_named_child ('chromatic').get_text ())
 894     chromatic_shift_normalized = chromatic_shift % 12;
 895     (shift.step, shift.alteration) = [
 896         (0,0), (0,1), (1,0), (2,-1), (2,0),
 897         (3,0), (3,1), (4,0), (5,-1), (5,0),
 898         (6,-1), (6,0)][chromatic_shift_normalized];
 899
 900     shift.octave += (chromatic_shift - chromatic_shift_normalized) / 12
 901
 902     diatonic = transpose.get_maybe_exist_named_child ('diatonic')
 903     if diatonic:
 904         diatonic_step = string.atoi (diatonic.get_text ()) % 7
 905         if diatonic_step != shift.step:
 906             # We got the alter incorrect!
 907             old_semitones = shift.semitones ()
 908             shift.step = diatonic_step
 909             new_semitones = shift.semitones ()
 910             shift.alteration += old_semitones - new_semitones
 911
 912     transposition = musicexp.Transposition ()
 913     transposition.pitch = musicexp.Pitch ().transposed (shift)
 914     return transposition
 915
 916
 917 def musicxml_attributes_to_lily (attrs):
 918     elts = []
 919     attr_dispatch =  {
 920         'clef': musicxml_clef_to_lily,
 921         'time': musicxml_time_to_lily,
 922         'key': musicxml_key_to_lily,
 923         'transpose': musicxml_transpose_to_lily,
 924     }
 925     for (k, func) in attr_dispatch.items ():
 926         children = attrs.get_named_children (k)
 927         if children:
 928             ev = func (attrs)
 929             if ev:
 930                 elts.append (ev)
 931
 932     return elts
 933
 934 class Marker (musicexp.Music):
 935     def __init__ (self):
 936         self.direction = 0
 937         self.event = None
 938     def print_ly (self, printer):
 939         ly.stderr_write (_ ("Encountered unprocessed marker %s\n") % self)
 940         pass
 941     def ly_expression (self):
 942         return ""
 943 class RepeatMarker (Marker):
 944     def __init__ (self):
 945         Marker.__init__ (self)
 946         self.times = 0
 947 class EndingMarker (Marker):
 948     pass
 949
 950 # Convert the <barline> element to musicxml.BarLine (for non-standard barlines)
 951 # and to RepeatMarker and EndingMarker objects for repeat and
 952 # alternatives start/stops
 953 def musicxml_barline_to_lily (barline):
 954     # retval contains all possible markers in the order:
 955     # 0..bw_ending, 1..bw_repeat, 2..barline, 3..fw_repeat, 4..fw_ending
 956     retval = {}
 957     bartype_element = barline.get_maybe_exist_named_child ("bar-style")
 958     repeat_element = barline.get_maybe_exist_named_child ("repeat")
 959     ending_element = barline.get_maybe_exist_named_child ("ending")
 960
 961     bartype = None
 962     if bartype_element:
 963         bartype = bartype_element.get_text ()
 964
 965     if repeat_element and hasattr (repeat_element, 'direction'):
 966         repeat = RepeatMarker ()
 967         repeat.direction = {"forward": -1, "backward": 1}.get (repeat_element.direction, 0)
 968
 969         if ( (repeat_element.direction == "forward" and bartype == "heavy-light") or
 970              (repeat_element.direction == "backward" and bartype == "light-heavy") ):
 971             bartype = None
 972         if hasattr (repeat_element, 'times'):
 973             try:
 974                 repeat.times = int (repeat_element.times)
 975             except ValueError:
 976                 repeat.times = 2
 977         repeat.event = barline
 978         if repeat.direction == -1:
 979             retval[3] = repeat
 980         else:
 981             retval[1] = repeat
 982
 983     if ending_element and hasattr (ending_element, 'type'):
 984         ending = EndingMarker ()
 985         ending.direction = {"start": -1, "stop": 1, "discontinue": 1}.get (ending_element.type, 0)
 986         ending.event = barline
 987         if ending.direction == -1:
 988             retval[4] = ending
 989         else:
 990             retval[0] = ending
 991
 992     if bartype:
 993         b = musicexp.BarLine ()
 994         b.type = bartype
 995         retval[2] = b
 996
 997     return retval.values ()
 998
 999 spanner_event_dict = {
1000     'beam' : musicexp.BeamEvent,
1001     'dashes' : musicexp.TextSpannerEvent,
1002     'bracket' : musicexp.BracketSpannerEvent,
1003     'glissando' : musicexp.GlissandoEvent,
1004     'octave-shift' : musicexp.OctaveShiftEvent,
1005     'pedal' : musicexp.PedalEvent,
1006     'slide' : musicexp.GlissandoEvent,
1007     'slur' : musicexp.SlurEvent,
1008     'wavy-line' : musicexp.TrillSpanEvent,
1009     'wedge' : musicexp.HairpinEvent
1010 }
1011 spanner_type_dict = {
1012     'start': -1,
1013     'begin': -1,
1014     'crescendo': -1,
1015     'decreschendo': -1,
1016     'diminuendo': -1,
1017     'continue': 0,
1018     'change': 0,
1019     'up': -1,
1020     'down': -1,
1021     'stop': 1,
1022     'end' : 1
1023 }
1024
1025 def musicxml_spanner_to_lily_event (mxl_event):
1026     ev = None
1027
1028     name = mxl_event.get_name()
1029     func = spanner_event_dict.get (name)
1030     if func:
1031         ev = func()
1032     else:
1033         error_message (_ ('unknown span event %s') % mxl_event)
1034
1035
1036     type = mxl_event.get_type ()
1037     span_direction = spanner_type_dict.get (type)
1038     # really check for None, because some types will be translated to 0, which
1039     # would otherwise also lead to the unknown span warning
1040     if span_direction != None:
1041         ev.span_direction = span_direction
1042     else:
1043         error_message (_ ('unknown span type %s for %s') % (type, name))
1044
1045     ev.set_span_type (type)
1046     ev.line_type = getattr (mxl_event, 'line-type', 'solid')
1047
1048     # assign the size, which is used for octave-shift, etc.
1049     ev.size = mxl_event.get_size ()
1050
1051     return ev
1052
1053 def musicxml_direction_to_indicator (direction):
1054     return { "above": 1, "upright": 1, "up": 1, "below": -1, "downright": -1, "down": -1, "inverted": -1 }.get (direction, 0)
1055
1056 def musicxml_fermata_to_lily_event (mxl_event):
1057     ev = musicexp.ArticulationEvent ()
1058     txt = mxl_event.get_text ()
1059     # The contents of the element defined the shape, possible are normal, angled and square
1060     ev.type = { "angled": "shortfermata", "square": "longfermata" }.get (txt, "fermata")
1061     if hasattr (mxl_event, 'type'):
1062       dir = musicxml_direction_to_indicator (mxl_event.type)
1063       if dir and options.convert_directions:
1064         ev.force_direction = dir
1065     return ev
1066
1067 def musicxml_arpeggiate_to_lily_event (mxl_event):
1068     ev = musicexp.ArpeggioEvent ()
1069     ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
1070     return ev
1071
1072 def musicxml_nonarpeggiate_to_lily_event (mxl_event):
1073     ev = musicexp.ArpeggioEvent ()
1074     ev.non_arpeggiate = True
1075     ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
1076     return ev
1077
1078 def musicxml_tremolo_to_lily_event (mxl_event):
1079     ev = musicexp.TremoloEvent ()
1080     txt = mxl_event.get_text ()
1081     if txt:
1082       ev.bars = txt
1083     else:
1084       ev.bars = "3"
1085     return ev
1086
1087 def musicxml_falloff_to_lily_event (mxl_event):
1088     ev = musicexp.BendEvent ()
1089     ev.alter = -4
1090     return ev
1091
1092 def musicxml_doit_to_lily_event (mxl_event):
1093     ev = musicexp.BendEvent ()
1094     ev.alter = 4
1095     return ev
1096
1097 def musicxml_bend_to_lily_event (mxl_event):
1098     ev = musicexp.BendEvent ()
1099     ev.alter = mxl_event.bend_alter ()
1100     return ev
1101
1102 def musicxml_caesura_to_lily_event (mxl_event):
1103     ev = musicexp.MarkupEvent ()
1104     # FIXME: default to straight or curved caesura?
1105     ev.contents = "\\musicglyph #\"scripts.caesura.straight\""
1106     ev.force_direction = 1
1107     return ev
1108
1109 def musicxml_fingering_event (mxl_event):
1110     ev = musicexp.ShortArticulationEvent ()
1111     ev.type = mxl_event.get_text ()
1112     return ev
1113
1114 def musicxml_string_event (mxl_event):
1115     ev = musicexp.NoDirectionArticulationEvent ()
1116     ev.type = mxl_event.get_text ()
1117     return ev
1118
1119 def musicxml_accidental_mark (mxl_event):
1120     ev = musicexp.MarkupEvent ()
1121     contents = { "sharp": "\\sharp",
1122       "natural": "\\natural",
1123       "flat": "\\flat",
1124       "double-sharp": "\\doublesharp",
1125       "sharp-sharp": "\\sharp\\sharp",
1126       "flat-flat": "\\flat\\flat",
1127       "flat-flat": "\\doubleflat",
1128       "natural-sharp": "\\natural\\sharp",
1129       "natural-flat": "\\natural\\flat",
1130       "quarter-flat": "\\semiflat",
1131       "quarter-sharp": "\\semisharp",
1132       "three-quarters-flat": "\\sesquiflat",
1133       "three-quarters-sharp": "\\sesquisharp",
1134     }.get (mxl_event.get_text ())
1135     if contents:
1136         ev.contents = contents
1137         return ev
1138     else:
1139         return None
1140
1141 # translate articulations, ornaments and other notations into ArticulationEvents
1142 # possible values:
1143 #   -) string  (ArticulationEvent with that name)
1144 #   -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
1145 #   -) (class, name)  (like string, only that a different class than ArticulationEvent is used)
1146 # TODO: Some translations are missing!
1147 articulations_dict = {
1148     "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
1149     "accidental-mark": musicxml_accidental_mark,
1150     "bend": musicxml_bend_to_lily_event,
1151     "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
1152     "caesura": musicxml_caesura_to_lily_event,
1153     #"delayed-turn": "?",
1154     "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
1155     "doit": musicxml_doit_to_lily_event,
1156     #"double-tongue": "?",
1157     "down-bow": "downbow",
1158     "falloff": musicxml_falloff_to_lily_event,
1159     "fingering": musicxml_fingering_event,
1160     #"fingernails": "?",
1161     #"fret": "?",
1162     #"hammer-on": "?",
1163     "harmonic": "flageolet",
1164     #"heel": "?",
1165     "inverted-mordent": "prall",
1166     "inverted-turn": "reverseturn",
1167     "mordent": "mordent",
1168     "open-string": "open",
1169     #"plop": "?",
1170     #"pluck": "?",
1171     #"pull-off": "?",
1172     #"schleifer": "?",
1173     #"scoop": "?",
1174     #"shake": "?",
1175     "snap-pizzicato": "snappizzicato",
1176     #"spiccato": "?",
1177     "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
1178     "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
1179     "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
1180     #"stress": "?",
1181     "string": musicxml_string_event,
1182     "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
1183     #"tap": "?",
1184     "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
1185     "thumb-position": "thumb",
1186     #"toe": "?",
1187     "turn": "turn",
1188     "tremolo": musicxml_tremolo_to_lily_event,
1189     "trill-mark": "trill",
1190     #"triple-tongue": "?",
1191     #"unstress": "?"
1192     "up-bow": "upbow",
1193     #"wavy-line": "?",
1194 }
1195 articulation_spanners = [ "wavy-line" ]
1196
1197 def musicxml_articulation_to_lily_event (mxl_event):
1198     # wavy-line elements are treated as trill spanners, not as articulation ornaments
1199     if mxl_event.get_name () in articulation_spanners:
1200         return musicxml_spanner_to_lily_event (mxl_event)
1201
1202     tmp_tp = articulations_dict.get (mxl_event.get_name ())
1203     if not tmp_tp:
1204         return
1205
1206     if isinstance (tmp_tp, str):
1207         ev = musicexp.ArticulationEvent ()
1208         ev.type = tmp_tp
1209     elif isinstance (tmp_tp, tuple):
1210         ev = tmp_tp[0] ()
1211         ev.type = tmp_tp[1]
1212     else:
1213         ev = tmp_tp (mxl_event)
1214
1215     # Some articulations use the type attribute, other the placement...
1216     dir = None
1217     if hasattr (mxl_event, 'type') and options.convert_directions:
1218         dir = musicxml_direction_to_indicator (mxl_event.type)
1219     if hasattr (mxl_event, 'placement') and options.convert_directions:
1220         dir = musicxml_direction_to_indicator (mxl_event.placement)
1221     if dir:
1222         ev.force_direction = dir
1223     return ev
1224
1225
1226
1227 def musicxml_dynamics_to_lily_event (dynentry):
1228     dynamics_available = (
1229         "ppppp", "pppp", "ppp", "pp", "p", "mp", "mf",
1230         "f", "ff", "fff", "ffff", "fp", "sf", "sff", "sp", "spp", "sfz", "rfz" )
1231     dynamicsname = dynentry.get_name ()
1232     if dynamicsname == "other-dynamics":
1233         dynamicsname = dynentry.get_text ()
1234     if not dynamicsname or dynamicsname=="#text":
1235         return
1236
1237     if not dynamicsname in dynamics_available:
1238         # Get rid of - in tag names (illegal in ly tags!)
1239         dynamicstext = dynamicsname
1240         dynamicsname = string.replace (dynamicsname, "-", "")
1241         additional_definitions[dynamicsname] = dynamicsname + \
1242               " = #(make-dynamic-script \"" + dynamicstext + "\")"
1243         needed_additional_definitions.append (dynamicsname)
1244     event = musicexp.DynamicsEvent ()
1245     event.type = dynamicsname
1246     return event
1247
1248 # Convert single-color two-byte strings to numbers 0.0 - 1.0
1249 def hexcolorval_to_nr (hex_val):
1250     try:
1251         v = int (hex_val, 16)
1252         if v == 255:
1253             v = 256
1254         return v / 256.
1255     except ValueError:
1256         return 0.
1257
1258 def hex_to_color (hex_val):
1259     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)
1260     if res:
1261         return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
1262     else:
1263         return None
1264
1265 def musicxml_words_to_lily_event (words):
1266     event = musicexp.TextEvent ()
1267     text = words.get_text ()
1268     text = re.sub ('^ *\n? *', '', text)
1269     text = re.sub (' *\n? *$', '', text)
1270     event.text = text
1271
1272     if hasattr (words, 'default-y') and options.convert_directions:
1273         offset = getattr (words, 'default-y')
1274         try:
1275             off = string.atoi (offset)
1276             if off > 0:
1277                 event.force_direction = 1
1278             else:
1279                 event.force_direction = -1
1280         except ValueError:
1281             event.force_direction = 0
1282
1283     if hasattr (words, 'font-weight'):
1284         font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
1285         if font_weight:
1286             event.markup += font_weight
1287
1288     if hasattr (words, 'font-size'):
1289         size = getattr (words, 'font-size')
1290         font_size = {
1291             "xx-small": '\\teeny',
1292             "x-small": '\\tiny',
1293             "small": '\\small',
1294             "medium": '',
1295             "large": '\\large',
1296             "x-large": '\\huge',
1297             "xx-large": '\\larger\\huge'
1298         }.get (size, '')
1299         if font_size:
1300             event.markup += font_size
1301
1302     if hasattr (words, 'color'):
1303         color = getattr (words, 'color')
1304         rgb = hex_to_color (color)
1305         if rgb:
1306             event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
1307
1308     if hasattr (words, 'font-style'):
1309         font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
1310         if font_style:
1311             event.markup += font_style
1312
1313     # TODO: How should I best convert the font-family attribute?
1314
1315     # TODO: How can I represent the underline, overline and line-through
1316     #       attributes in Lilypond? Values of these attributes indicate
1317     #       the number of lines
1318
1319     return event
1320
1321
1322 # convert accordion-registration to lilypond.
1323 # Since lilypond does not have any built-in commands, we need to create
1324 # the markup commands manually and define our own variables.
1325 # Idea was taken from: http://lsr.dsi.unimi.it/LSR/Item?id=194
1326 def musicxml_accordion_to_markup (mxl_event):
1327     commandname = "accReg"
1328     command = ""
1329
1330     high = mxl_event.get_maybe_exist_named_child ('accordion-high')
1331     if high:
1332         commandname += "H"
1333         command += """\\combine
1334           \\raise #2.5 \\musicglyph #\"accordion.accDot\"
1335           """
1336     middle = mxl_event.get_maybe_exist_named_child ('accordion-middle')
1337     if middle:
1338         # By default, use one dot (when no or invalid content is given). The
1339         # MusicXML spec is quiet about this case...
1340         txt = 1
1341         try:
1342           txt = string.atoi (middle.get_text ())
1343         except ValueError:
1344             pass
1345         if txt == 3:
1346             commandname += "MMM"
1347             command += """\\combine
1348           \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1349           \\combine
1350           \\raise #1.5 \\translate #(cons 1 0) \\musicglyph #\"accordion.accDot\"
1351           \\combine
1352           \\raise #1.5 \\translate #(cons -1 0) \\musicglyph #\"accordion.accDot\"
1353           """
1354         elif txt == 2:
1355             commandname += "MM"
1356             command += """\\combine
1357           \\raise #1.5 \\translate #(cons 0.5 0) \\musicglyph #\"accordion.accDot\"
1358           \\combine
1359           \\raise #1.5 \\translate #(cons -0.5 0) \\musicglyph #\"accordion.accDot\"
1360           """
1361         elif not txt <= 0:
1362             commandname += "M"
1363             command += """\\combine
1364           \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1365           """
1366     low = mxl_event.get_maybe_exist_named_child ('accordion-low')
1367     if low:
1368         commandname += "L"
1369         command += """\\combine
1370           \\raise #0.5 \musicglyph #\"accordion.accDot\"
1371           """
1372
1373     command += "\musicglyph #\"accordion.accDiscant\""
1374     command = "\\markup { \\normalsize %s }" % command
1375     # Define the newly built command \accReg[H][MMM][L]
1376     additional_definitions[commandname] = "%s = %s" % (commandname, command)
1377     needed_additional_definitions.append (commandname)
1378     return "\\%s" % commandname
1379
1380 def musicxml_accordion_to_ly (mxl_event):
1381     txt = musicxml_accordion_to_markup (mxl_event)
1382     if txt:
1383         ev = musicexp.MarkEvent (txt)
1384         return ev
1385     return
1386
1387
1388 def musicxml_rehearsal_to_ly_mark (mxl_event):
1389     text = mxl_event.get_text ()
1390     if not text:
1391         return
1392     # default is boxed rehearsal marks!
1393     encl = "box"
1394     if hasattr (mxl_event, 'enclosure'):
1395         encl = {"none": None, "square": "box", "circle": "circle" }.get (mxl_event.enclosure, None)
1396     if encl:
1397         text = "\\%s { %s }" % (encl, text)
1398     ev = musicexp.MarkEvent ("\\markup { %s }" % text)
1399     return ev
1400
1401 def musicxml_harp_pedals_to_ly (mxl_event):
1402     count = 0
1403     result = "\\harp-pedal #\""
1404     for t in mxl_event.get_named_children ('pedal-tuning'):
1405       alter = t.get_named_child ('pedal-alter')
1406       if alter:
1407         val = int (alter.get_text ().strip ())
1408         result += {1: "v", 0: "-", -1: "^"}.get (val, "")
1409       count += 1
1410       if count == 3:
1411         result += "|"
1412     ev = musicexp.MarkupEvent ()
1413     ev.contents = result + "\""
1414     return ev
1415
1416 def musicxml_eyeglasses_to_ly (mxl_event):
1417     needed_additional_definitions.append ("eyeglasses")
1418     return musicexp.MarkEvent ("\\markup { \\eyeglasses }")
1419
1420 def next_non_hash_index (lst, pos):
1421     pos += 1
1422     while pos < len (lst) and isinstance (lst[pos], musicxml.Hash_text):
1423         pos += 1
1424     return pos
1425
1426 def musicxml_metronome_to_ly (mxl_event):
1427     children = mxl_event.get_all_children ()
1428     if not children:
1429         return
1430
1431     index = -1
1432     index = next_non_hash_index (children, index)
1433     if isinstance (children[index], musicxml.BeatUnit):
1434         # first form of metronome-mark, using unit and beats/min or other unit
1435         ev = musicexp.TempoMark ()
1436         if hasattr (mxl_event, 'parentheses'):
1437             ev.set_parentheses (mxl_event.parentheses == "yes")
1438
1439         d = musicexp.Duration ()
1440         d.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1441         index = next_non_hash_index (children, index)
1442         if isinstance (children[index], musicxml.BeatUnitDot):
1443             d.dots = 1
1444             index = next_non_hash_index (children, index)
1445         ev.set_base_duration (d)
1446         if isinstance (children[index], musicxml.BeatUnit):
1447             # Form "note = newnote"
1448             newd = musicexp.Duration ()
1449             newd.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1450             index = next_non_hash_index (children, index)
1451             if isinstance (children[index], musicxml.BeatUnitDot):
1452                 newd.dots = 1
1453                 index = next_non_hash_index (children, index)
1454             ev.set_new_duration (newd)
1455         elif isinstance (children[index], musicxml.PerMinute):
1456             # Form "note = bpm"
1457             try:
1458                 beats = int (children[index].get_text ())
1459                 ev.set_beats_per_minute (beats)
1460             except ValueError:
1461                 pass
1462         else:
1463             error_message (_ ("Unknown metronome mark, ignoring"))
1464             return
1465         return ev
1466     else:
1467         #TODO: Implement the other (more complex) way for tempo marks!
1468         error_message (_ ("Metronome marks with complex relations (<metronome-note> in MusicXML) are not yet implemented."))
1469         return
1470
1471 # translate directions into Events, possible values:
1472 #   -) string  (MarkEvent with that command)
1473 #   -) function (function(mxl_event) needs to return a full Event-derived object
1474 #   -) (class, name)  (like string, only that a different class than MarkEvent is used)
1475 directions_dict = {
1476     'accordion-registration' : musicxml_accordion_to_ly,
1477     'coda' : (musicexp.MusicGlyphMarkEvent, "coda"),
1478 #     'damp' : ???
1479 #     'damp-all' : ???
1480     'eyeglasses': musicxml_eyeglasses_to_ly,
1481     'harp-pedals' : musicxml_harp_pedals_to_ly,
1482 #     'image' : ???
1483     'metronome' : musicxml_metronome_to_ly,
1484     'rehearsal' : musicxml_rehearsal_to_ly_mark,
1485 #     'scordatura' : ???
1486     'segno' : (musicexp.MusicGlyphMarkEvent, "segno"),
1487     'words' : musicxml_words_to_lily_event,
1488 }
1489 directions_spanners = [ 'octave-shift', 'pedal', 'wedge', 'dashes', 'bracket' ]
1490
1491 def musicxml_direction_to_lily (n):
1492     # TODO: Handle the <staff> element!
1493     res = []
1494     # placement applies to all children!
1495     dir = None
1496     if hasattr (n, 'placement') and options.convert_directions:
1497         dir = musicxml_direction_to_indicator (n.placement)
1498     dirtype_children = []
1499     # TODO: The direction-type is used for grouping (e.g. dynamics with text),
1500     #       so we can't simply flatten them out!
1501     for dt in n.get_typed_children (musicxml.DirType):
1502         dirtype_children += dt.get_all_children ()
1503
1504     for entry in dirtype_children:
1505         # backets, dashes, octave shifts. pedal marks, hairpins etc. are spanners:
1506         if entry.get_name() in directions_spanners:
1507             event = musicxml_spanner_to_lily_event (entry)
1508             if event:
1509                 res.append (event)
1510             continue
1511
1512         # now treat all the "simple" ones, that can be translated using the dict
1513         ev = None
1514         tmp_tp = directions_dict.get (entry.get_name (), None)
1515         if isinstance (tmp_tp, str): # string means MarkEvent
1516             ev = musicexp.MarkEvent (tmp_tp)
1517         elif isinstance (tmp_tp, tuple): # tuple means (EventClass, "text")
1518             ev = tmp_tp[0] (tmp_tp[1])
1519         elif tmp_tp:
1520             ev = tmp_tp (entry)
1521         if ev:
1522             # TODO: set the correct direction! Unfortunately, \mark in ly does
1523             #       not seem to support directions!
1524             res.append (ev)
1525             continue
1526
1527         if entry.get_name () == "dynamics":
1528             for dynentry in entry.get_all_children ():
1529                 ev = musicxml_dynamics_to_lily_event (dynentry)
1530                 if ev:
1531                     res.append (ev)
1532
1533     return res
1534
1535 def musicxml_frame_to_lily_event (frame):
1536     ev = musicexp.FretEvent ()
1537     ev.strings = frame.get_strings ()
1538     ev.frets = frame.get_frets ()
1539     #offset = frame.get_first_fret () - 1
1540     barre = []
1541     for fn in frame.get_named_children ('frame-note'):
1542         fret = fn.get_fret ()
1543         if fret <= 0:
1544             fret = "o"
1545         el = [ fn.get_string (), fret ]
1546         fingering = fn.get_fingering ()
1547         if fingering >= 0:
1548             el.append (fingering)
1549         ev.elements.append (el)
1550         b = fn.get_barre ()
1551         if b == 'start':
1552             barre[0] = el[0] # start string
1553             barre[2] = el[1] # fret
1554         elif b == 'stop':
1555             barre[1] = el[0] # end string
1556     if barre:
1557         ev.barre = barre
1558     return ev
1559
1560 def musicxml_harmony_to_lily (n):
1561     res = []
1562     for f in n.get_named_children ('frame'):
1563         ev = musicxml_frame_to_lily_event (f)
1564         if ev:
1565             res.append (ev)
1566     return res
1567
1568
1569 notehead_styles_dict = {
1570     'slash': '\'slash',
1571     'triangle': '\'triangle',
1572     'diamond': '\'diamond',
1573     'square': '\'la', # TODO: Proper squared note head
1574     'cross': None, # TODO: + shaped note head
1575     'x': '\'cross',
1576     'circle-x': '\'xcircle',
1577     'inverted triangle': None, # TODO: Implement
1578     'arrow down': None, # TODO: Implement
1579     'arrow up': None, # TODO: Implement
1580     'slashed': None, # TODO: Implement
1581     'back slashed': None, # TODO: Implement
1582     'normal': None,
1583     'cluster': None, # TODO: Implement
1584     'none': '#f',
1585     'do': '\'do',
1586     're': '\'re',
1587     'mi': '\'mi',
1588     'fa': '\'fa',
1589     'so': None,
1590     'la': '\'la',
1591     'ti': '\'ti',
1592     }
1593
1594 def musicxml_notehead_to_lily (nh):
1595     styles = []
1596
1597     # Notehead style
1598     style = notehead_styles_dict.get (nh.get_text ().strip (), None)
1599     style_elm = musicexp.NotestyleEvent ()
1600     if style:
1601         style_elm.style = style
1602     if hasattr (nh, 'filled'):
1603         style_elm.filled = (getattr (nh, 'filled') == "yes")
1604     if style_elm.style or (style_elm.filled != None):
1605         styles.append (style_elm)
1606
1607     # parentheses
1608     if hasattr (nh, 'parentheses') and (nh.parentheses == "yes"):
1609         styles.append (musicexp.ParenthesizeEvent ())
1610
1611     return styles
1612
1613 def musicxml_chordpitch_to_lily (mxl_cpitch):
1614     r = musicexp.ChordPitch ()
1615     r.alteration = mxl_cpitch.get_alteration ()
1616     r.step = musicxml_step_to_lily (mxl_cpitch.get_step ())
1617     return r
1618
1619 chordkind_dict = {
1620     'major': '5',
1621     'minor': 'm5',
1622     'augmented': 'aug5',
1623     'diminished': 'dim5',
1624         # Sevenths:
1625     'dominant': '7',
1626     'dominant-seventh': '7',
1627     'major-seventh': 'maj7',
1628     'minor-seventh': 'm7',
1629     'diminished-seventh': 'dim7',
1630     'augmented-seventh': 'aug7',
1631     'half-diminished': 'dim5m7',
1632     'major-minor': 'maj7m5',
1633         # Sixths:
1634     'major-sixth': '6',
1635     'minor-sixth': 'm6',
1636         # Ninths:
1637     'dominant-ninth': '9',
1638     'major-ninth': 'maj9',
1639     'minor-ninth': 'm9',
1640         # 11ths (usually as the basis for alteration):
1641     'dominant-11th': '11',
1642     'major-11th': 'maj11',
1643     'minor-11th': 'm11',
1644         # 13ths (usually as the basis for alteration):
1645     'dominant-13th': '13.11',
1646     'major-13th': 'maj13.11',
1647     'minor-13th': 'm13',
1648         # Suspended:
1649     'suspended-second': 'sus2',
1650     'suspended-fourth': 'sus4',
1651         # Functional sixths:
1652     # TODO
1653     #'Neapolitan': '???',
1654     #'Italian': '???',
1655     #'French': '???',
1656     #'German': '???',
1657         # Other:
1658     #'pedal': '???',(pedal-point bass)
1659     'power': '5^3',
1660     #'Tristan': '???',
1661     'other': '1',
1662     'none': None,
1663 }
1664
1665 def musicxml_chordkind_to_lily (kind):
1666     res = chordkind_dict.get (kind, None)
1667     # Check for None, since a major chord is converted to ''
1668     if res == None:
1669         error_message (_ ("Unable to convert chord type %s to lilypond.") % kind)
1670     return res
1671
1672 def musicxml_harmony_to_lily_chordname (n):
1673     res = []
1674     root = n.get_maybe_exist_named_child ('root')
1675     if root:
1676         ev = musicexp.ChordNameEvent ()
1677         ev.root = musicxml_chordpitch_to_lily (root)
1678         kind = n.get_maybe_exist_named_child ('kind')
1679         if kind:
1680             ev.kind = musicxml_chordkind_to_lily (kind.get_text ())
1681             if not ev.kind:
1682                 return res
1683         bass = n.get_maybe_exist_named_child ('bass')
1684         if bass:
1685             ev.bass = musicxml_chordpitch_to_lily (bass)
1686         inversion = n.get_maybe_exist_named_child ('inversion')
1687         if inversion:
1688             # TODO: Lilypond does not support inversions, does it?
1689
1690             # Mail from Carl Sorensen on lilypond-devel, June 11, 2008:
1691             # 4. LilyPond supports the first inversion in the form of added
1692             # bass notes.  So the first inversion of C major would be c:/g.
1693             # To get the second inversion of C major, you would need to do
1694             # e:6-3-^5 or e:m6-^5.  However, both of these techniques
1695             # require you to know the chord and calculate either the fifth
1696             # pitch (for the first inversion) or the third pitch (for the
1697             # second inversion) so they may not be helpful for musicxml2ly.
1698             inversion_count = string.atoi (inversion.get_text ())
1699             if inversion_count == 1:
1700               # TODO: Calculate the bass note for the inversion...
1701               pass
1702             pass
1703         for deg in n.get_named_children ('degree'):
1704             d = musicexp.ChordModification ()
1705             d.type = deg.get_type ()
1706             d.step = deg.get_value ()
1707             d.alteration = deg.get_alter ()
1708             ev.add_modification (d)
1709         #TODO: convert the user-symbols attribute:
1710             #major: a triangle, like Unicode 25B3
1711             #minor: -, like Unicode 002D
1712             #augmented: +, like Unicode 002B
1713             #diminished: (degree), like Unicode 00B0
1714             #half-diminished: (o with slash), like Unicode 00F8
1715         if ev and ev.root:
1716             res.append (ev)
1717
1718     return res
1719
1720 def musicxml_figured_bass_note_to_lily (n):
1721     res = musicexp.FiguredBassNote ()
1722     suffix_dict = { 'sharp' : "+",
1723                     'flat' : "-",
1724                     'natural' : "!",
1725                     'double-sharp' : "++",
1726                     'flat-flat' : "--",
1727                     'sharp-sharp' : "++",
1728                     'slash' : "/" }
1729     prefix = n.get_maybe_exist_named_child ('prefix')
1730     if prefix:
1731         res.set_prefix (suffix_dict.get (prefix.get_text (), ""))
1732     fnumber = n.get_maybe_exist_named_child ('figure-number')
1733     if fnumber:
1734         res.set_number (fnumber.get_text ())
1735     suffix = n.get_maybe_exist_named_child ('suffix')
1736     if suffix:
1737         res.set_suffix (suffix_dict.get (suffix.get_text (), ""))
1738     if n.get_maybe_exist_named_child ('extend'):
1739         # TODO: Implement extender lines (unfortunately, in lilypond you have
1740         #       to use \set useBassFigureExtenders = ##t, which turns them on
1741         #       globally, while MusicXML has a property for each note...
1742         #       I'm not sure there is a proper way to implement this cleanly
1743         #n.extend
1744         pass
1745     return res
1746
1747
1748
1749 def musicxml_figured_bass_to_lily (n):
1750     if not isinstance (n, musicxml.FiguredBass):
1751         return
1752     res = musicexp.FiguredBassEvent ()
1753     for i in n.get_named_children ('figure'):
1754         note = musicxml_figured_bass_note_to_lily (i)
1755         if note:
1756             res.append (note)
1757     dur = n.get_maybe_exist_named_child ('duration')
1758     if dur:
1759         # apply the duration to res
1760         length = Rational(int(dur.get_text()), n._divisions)*Rational(1,4)
1761         res.set_real_duration (length)
1762         duration = rational_to_lily_duration (length)
1763         if duration:
1764             res.set_duration (duration)
1765     if hasattr (n, 'parentheses') and n.parentheses == "yes":
1766         res.set_parentheses (True)
1767     return res
1768
1769 instrument_drumtype_dict = {
1770     'Acoustic Snare Drum': 'acousticsnare',
1771     'Side Stick': 'sidestick',
1772     'Open Triangle': 'opentriangle',
1773     'Mute Triangle': 'mutetriangle',
1774     'Tambourine': 'tambourine',
1775     'Bass Drum': 'bassdrum',
1776 }
1777
1778 def musicxml_note_to_lily_main_event (n):
1779     pitch  = None
1780     duration = None
1781     event = None
1782
1783     mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1784     if mxl_pitch:
1785         pitch = musicxml_pitch_to_lily (mxl_pitch)
1786         event = musicexp.NoteEvent ()
1787         event.pitch = pitch
1788
1789         acc = n.get_maybe_exist_named_child ('accidental')
1790         if acc:
1791             # let's not force accs everywhere.
1792             event.cautionary = acc.editorial
1793
1794     elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1795         # Unpitched elements have display-step and can also have
1796         # display-octave.
1797         unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1798         event = musicexp.NoteEvent ()
1799         event.pitch = musicxml_unpitched_to_lily (unpitched)
1800
1801     elif n.get_maybe_exist_typed_child (musicxml.Rest):
1802         # rests can have display-octave and display-step, which are
1803         # treated like an ordinary note pitch
1804         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1805         event = musicexp.RestEvent ()
1806         if options.convert_rest_positions:
1807             pitch = musicxml_restdisplay_to_lily (rest)
1808             event.pitch = pitch
1809
1810     elif n.instrument_name:
1811         event = musicexp.NoteEvent ()
1812         drum_type = instrument_drumtype_dict.get (n.instrument_name)
1813         if drum_type:
1814             event.drum_type = drum_type
1815         else:
1816             n.message (_ ("drum %s type unknown, please add to instrument_drumtype_dict") % n.instrument_name)
1817             event.drum_type = 'acousticsnare'
1818
1819     else:
1820         n.message (_ ("cannot find suitable event"))
1821
1822     if event:
1823         event.duration = musicxml_duration_to_lily (n)
1824
1825     noteheads = n.get_named_children ('notehead')
1826     for nh in noteheads:
1827         styles = musicxml_notehead_to_lily (nh)
1828         for s in styles:
1829             event.add_associated_event (s)
1830
1831     return event
1832
1833 def musicxml_lyrics_to_text (lyrics):
1834     # TODO: Implement text styles for lyrics syllables
1835     continued = False
1836     extended = False
1837     text = ''
1838     for e in lyrics.get_all_children ():
1839         if isinstance (e, musicxml.Syllabic):
1840             continued = e.continued ()
1841         elif isinstance (e, musicxml.Text):
1842             # We need to convert soft hyphens to -, otherwise the ascii codec as well
1843             # as lilypond will barf on that character
1844             text += string.replace( e.get_text(), u'\xad', '-' )
1845         elif isinstance (e, musicxml.Elision):
1846             if text:
1847                 text += " "
1848             continued = False
1849             extended = False
1850         elif isinstance (e, musicxml.Extend):
1851             if text:
1852                 text += " "
1853             extended = True
1854
1855     if text == "-" and continued:
1856         return "--"
1857     elif text == "_" and extended:
1858         return "__"
1859     elif continued and text:
1860         return musicxml.escape_ly_output_string (text) + " --"
1861     elif continued:
1862         return "--"
1863     elif extended and text:
1864         return musicxml.escape_ly_output_string (text) + " __"
1865     elif extended:
1866         return "__"
1867     elif text:
1868         return musicxml.escape_ly_output_string (text)
1869     else:
1870         return ""
1871
1872 ## TODO
1873 class NegativeSkip:
1874     def __init__ (self, here, dest):
1875         self.here = here
1876         self.dest = dest
1877
1878 class LilyPondVoiceBuilder:
1879     def __init__ (self):
1880         self.elements = []
1881         self.pending_dynamics = []
1882         self.end_moment = Rational (0)
1883         self.begin_moment = Rational (0)
1884         self.pending_multibar = Rational (0)
1885         self.ignore_skips = False
1886         self.has_relevant_elements = False
1887         self.measure_length = Rational (4, 4)
1888
1889     def _insert_multibar (self):
1890         layout_information.set_context_item ('Score', 'skipBars = ##t')
1891         r = musicexp.MultiMeasureRest ()
1892         lenfrac = self.measure_length
1893         r.duration = rational_to_lily_duration (lenfrac)
1894         r.duration.factor *= self.pending_multibar / lenfrac
1895         self.elements.append (r)
1896         self.begin_moment = self.end_moment
1897         self.end_moment = self.begin_moment + self.pending_multibar
1898         self.pending_multibar = Rational (0)
1899
1900     def set_measure_length (self, mlen):
1901         if (mlen != self.measure_length) and self.pending_multibar:
1902             self._insert_multibar ()
1903         self.measure_length = mlen
1904
1905     def add_multibar_rest (self, duration):
1906         self.pending_multibar += duration
1907
1908     def set_duration (self, duration):
1909         self.end_moment = self.begin_moment + duration
1910     def current_duration (self):
1911         return self.end_moment - self.begin_moment
1912
1913     def add_music (self, music, duration, relevant = True):
1914         assert isinstance (music, musicexp.Music)
1915         if self.pending_multibar > Rational (0):
1916             self._insert_multibar ()
1917
1918         self.has_relevant_elements = self.has_relevant_elements or relevant
1919         self.elements.append (music)
1920         self.begin_moment = self.end_moment
1921         self.set_duration (duration)
1922
1923         # Insert all pending dynamics right after the note/rest:
1924         if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1925             for d in self.pending_dynamics:
1926                 music.append (d)
1927             self.pending_dynamics = []
1928
1929     # Insert some music command that does not affect the position in the measure
1930     def add_command (self, command, relevant = True):
1931         assert isinstance (command, musicexp.Music)
1932         if self.pending_multibar > Rational (0):
1933             self._insert_multibar ()
1934         self.has_relevant_elements = self.has_relevant_elements or relevant
1935         self.elements.append (command)
1936     def add_barline (self, barline, relevant = False):
1937         # Insert only if we don't have a barline already
1938         # TODO: Implement proper merging of default barline and custom bar line
1939         has_relevant = self.has_relevant_elements
1940         if (not (self.elements) or
1941             not (isinstance (self.elements[-1], musicexp.BarLine)) or
1942             (self.pending_multibar > Rational (0))):
1943             self.add_music (barline, Rational (0))
1944         self.has_relevant_elements = has_relevant or relevant
1945     def add_partial (self, command):
1946         self.ignore_skips = True
1947         # insert the partial, but restore relevant_elements (partial is not relevant)
1948         relevant = self.has_relevant_elements
1949         self.add_command (command)
1950         self.has_relevant_elements = relevant
1951
1952     def add_dynamics (self, dynamic):
1953         # store the dynamic item(s) until we encounter the next note/rest:
1954         self.pending_dynamics.append (dynamic)
1955
1956     def add_bar_check (self, number):
1957         # re/store has_relevant_elements, so that a barline alone does not
1958         # trigger output for figured bass, chord names
1959         b = musicexp.BarLine ()
1960         b.bar_number = number
1961         self.add_barline (b)
1962
1963     def jumpto (self, moment):
1964         current_end = self.end_moment + self.pending_multibar
1965         diff = moment - current_end
1966
1967         if diff < Rational (0):
1968             error_message (_ ('Negative skip %s (from position %s to %s)') %
1969                              (diff, current_end, moment))
1970             diff = Rational (0)
1971
1972         if diff > Rational (0) and not (self.ignore_skips and moment == 0):
1973             skip = musicexp.SkipEvent()
1974             duration_factor = 1
1975             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)
1976             duration_dots = 0
1977             # TODO: Use the time signature for skips, too. Problem: The skip
1978             #       might not start at a measure boundary!
1979             if duration_log > 0: # denominator is a power of 2...
1980                 if diff.numerator () == 3:
1981                     duration_log -= 1
1982                     duration_dots = 1
1983                 else:
1984                     duration_factor = Rational (diff.numerator ())
1985             else:
1986                 # for skips of a whole or more, simply use s1*factor
1987                 duration_log = 0
1988                 duration_factor = diff
1989             skip.duration.duration_log = duration_log
1990             skip.duration.factor = duration_factor
1991             skip.duration.dots = duration_dots
1992
1993             evc = musicexp.ChordEvent ()
1994             evc.elements.append (skip)
1995             self.add_music (evc, diff, False)
1996
1997         if diff > Rational (0) and moment == 0:
1998             self.ignore_skips = False
1999
2000     def last_event_chord (self, starting_at):
2001
2002         value = None
2003
2004         # if the position matches, find the last ChordEvent, do not cross a bar line!
2005         at = len( self.elements ) - 1
2006         while (at >= 0 and
2007                not isinstance (self.elements[at], musicexp.ChordEvent) and
2008                not isinstance (self.elements[at], musicexp.BarLine)):
2009             at -= 1
2010
2011         if (self.elements
2012             and at >= 0
2013             and isinstance (self.elements[at], musicexp.ChordEvent)
2014             and self.begin_moment == starting_at):
2015             value = self.elements[at]
2016         else:
2017             self.jumpto (starting_at)
2018             value = None
2019         return value
2020
2021     def correct_negative_skip (self, goto):
2022         self.end_moment = goto
2023         self.begin_moment = goto
2024         evc = musicexp.ChordEvent ()
2025         self.elements.append (evc)
2026
2027
2028 class VoiceData:
2029     def __init__ (self):
2030         self.voicename = None
2031         self.voicedata = None
2032         self.ly_voice = None
2033         self.figured_bass = None
2034         self.chordnames = None
2035         self.lyrics_dict = {}
2036         self.lyrics_order = []
2037
2038 def musicxml_step_to_lily (step):
2039     if step:
2040         return (ord (step) - ord ('A') + 7 - 2) % 7
2041     else:
2042         return None
2043
2044 def measure_length_from_attributes (attr, current_measure_length):
2045     len = attr.get_measure_length ()
2046     if not len:
2047         len = current_measure_length
2048     return len
2049
2050 def musicxml_voice_to_lily_voice (voice):
2051     tuplet_events = []
2052     modes_found = {}
2053     lyrics = {}
2054     return_value = VoiceData ()
2055     return_value.voicedata = voice
2056
2057     # First pitch needed for relative mode (if selected in command-line options)
2058     first_pitch = None
2059
2060     # Needed for melismata detection (ignore lyrics on those notes!):
2061     inside_slur = False
2062     is_tied = False
2063     is_chord = False
2064     is_beamed = False
2065     ignore_lyrics = False
2066
2067     current_staff = None
2068
2069     pending_figured_bass = []
2070     pending_chordnames = []
2071
2072     # Make sure that the keys in the dict don't get reordered, since
2073     # we need the correct ordering of the lyrics stanzas! By default,
2074     # a dict will reorder its keys
2075     return_value.lyrics_order = voice.get_lyrics_numbers ()
2076     for k in return_value.lyrics_order:
2077         lyrics[k] = []
2078
2079     voice_builder = LilyPondVoiceBuilder ()
2080     figured_bass_builder = LilyPondVoiceBuilder ()
2081     chordnames_builder = LilyPondVoiceBuilder ()
2082     current_measure_length = Rational (4, 4)
2083     voice_builder.set_measure_length (current_measure_length)
2084
2085     for n in voice._elements:
2086         if n.get_name () == 'forward':
2087             continue
2088         staff = n.get_maybe_exist_named_child ('staff')
2089         if staff:
2090             staff = staff.get_text ()
2091             if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
2092                 voice_builder.add_command (musicexp.StaffChange (staff))
2093             current_staff = staff
2094
2095         if isinstance (n, musicxml.Partial) and n.partial > 0:
2096             a = musicxml_partial_to_lily (n.partial)
2097             if a:
2098                 voice_builder.add_partial (a)
2099                 figured_bass_builder.add_partial (a)
2100                 chordnames_builder.add_partial (a)
2101             continue
2102
2103         is_chord = n.get_maybe_exist_named_child ('chord')
2104         is_after_grace = (isinstance (n, musicxml.Note) and n.is_after_grace ());
2105         if not is_chord and not is_after_grace:
2106             try:
2107                 voice_builder.jumpto (n._when)
2108                 figured_bass_builder.jumpto (n._when)
2109                 chordnames_builder.jumpto (n._when)
2110             except NegativeSkip, neg:
2111                 voice_builder.correct_negative_skip (n._when)
2112                 figured_bass_builder.correct_negative_skip (n._when)
2113                 chordnames_builder.correct_negative_skip (n._when)
2114                 n.message (_ ("Negative skip found: from %s to %s, difference is %s") % (neg.here, neg.dest, neg.dest - neg.here))
2115
2116         if isinstance (n, musicxml.Barline):
2117             barlines = musicxml_barline_to_lily (n)
2118             for a in barlines:
2119                 if isinstance (a, musicexp.BarLine):
2120                     voice_builder.add_barline (a)
2121                     figured_bass_builder.add_barline (a, False)
2122                     chordnames_builder.add_barline (a, False)
2123                 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
2124                     voice_builder.add_command (a)
2125                     figured_bass_builder.add_barline (a, False)
2126                     chordnames_builder.add_barline (a, False)
2127             continue
2128
2129         # Continue any multimeasure-rests before trying to add bar checks!
2130         # Don't handle new MM rests yet, because for them we want bar checks!
2131         rest = n.get_maybe_exist_typed_child (musicxml.Rest)
2132         if (rest and rest.is_whole_measure ()
2133                  and voice_builder.pending_multibar > Rational (0)):
2134             voice_builder.add_multibar_rest (n._duration)
2135             continue
2136
2137
2138         # print a bar check at the beginning of each measure!
2139         if n.is_first () and n._measure_position == Rational (0) and n != voice._elements[0]:
2140             try:
2141                 num = int (n.get_parent ().number)
2142             except ValueError:
2143                 num = 0
2144             if num > 0:
2145                 voice_builder.add_bar_check (num)
2146                 figured_bass_builder.add_bar_check (num)
2147                 chordnames_builder.add_bar_check (num)
2148
2149         # Start any new multimeasure rests
2150         if (rest and rest.is_whole_measure ()):
2151             voice_builder.add_multibar_rest (n._duration)
2152             continue
2153
2154
2155         if isinstance (n, musicxml.Direction):
2156             for a in musicxml_direction_to_lily (n):
2157                 if a.wait_for_note ():
2158                     voice_builder.add_dynamics (a)
2159                 else:
2160                     voice_builder.add_command (a)
2161             continue
2162
2163         if isinstance (n, musicxml.Harmony):
2164             for a in musicxml_harmony_to_lily (n):
2165                 if a.wait_for_note ():
2166                     voice_builder.add_dynamics (a)
2167                 else:
2168                     voice_builder.add_command (a)
2169             for a in musicxml_harmony_to_lily_chordname (n):
2170                 pending_chordnames.append (a)
2171             continue
2172
2173         if isinstance (n, musicxml.FiguredBass):
2174             a = musicxml_figured_bass_to_lily (n)
2175             if a:
2176                 pending_figured_bass.append (a)
2177             continue
2178
2179         if isinstance (n, musicxml.Attributes):
2180             for a in musicxml_attributes_to_lily (n):
2181                 voice_builder.add_command (a)
2182             measure_length = measure_length_from_attributes (n, current_measure_length)
2183             if current_measure_length != measure_length:
2184                 current_measure_length = measure_length
2185                 voice_builder.set_measure_length (current_measure_length)
2186             continue
2187
2188         if not n.__class__.__name__ == 'Note':
2189             n.message (_ ('unexpected %s; expected %s or %s or %s') % (n, 'Note', 'Attributes', 'Barline'))
2190             continue
2191
2192         main_event = musicxml_note_to_lily_main_event (n)
2193         if main_event and not first_pitch:
2194             first_pitch = main_event.pitch
2195         # ignore lyrics for notes inside a slur, tie, chord or beam
2196         ignore_lyrics = inside_slur or is_tied or is_chord or is_beamed
2197
2198         if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
2199             modes_found['drummode'] = True
2200
2201         ev_chord = voice_builder.last_event_chord (n._when)
2202         if not ev_chord:
2203             ev_chord = musicexp.ChordEvent()
2204             voice_builder.add_music (ev_chord, n._duration)
2205
2206         # For grace notes:
2207         grace = n.get_maybe_exist_typed_child (musicxml.Grace)
2208         if n.is_grace ():
2209             is_after_grace = ev_chord.has_elements () or n.is_after_grace ();
2210             is_chord = n.get_maybe_exist_typed_child (musicxml.Chord)
2211
2212             grace_chord = None
2213
2214             # after-graces and other graces use different lists; Depending on
2215             # whether we have a chord or not, obtain either a new ChordEvent or
2216             # the previous one to create a chord
2217             if is_after_grace:
2218                 if ev_chord.after_grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
2219                     grace_chord = ev_chord.after_grace_elements.get_last_event_chord ()
2220                 if not grace_chord:
2221                     grace_chord = musicexp.ChordEvent ()
2222                     ev_chord.append_after_grace (grace_chord)
2223             elif n.is_grace ():
2224                 if ev_chord.grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
2225                     grace_chord = ev_chord.grace_elements.get_last_event_chord ()
2226                 if not grace_chord:
2227                     grace_chord = musicexp.ChordEvent ()
2228                     ev_chord.append_grace (grace_chord)
2229
2230             if hasattr (grace, 'slash') and not is_after_grace:
2231                 # TODO: use grace_type = "appoggiatura" for slurred grace notes
2232                 if grace.slash == "yes":
2233                     ev_chord.grace_type = "acciaccatura"
2234             # now that we have inserted the chord into the grace music, insert
2235             # everything into that chord instead of the ev_chord
2236             ev_chord = grace_chord
2237             ev_chord.append (main_event)
2238             ignore_lyrics = True
2239         else:
2240             ev_chord.append (main_event)
2241             # When a note/chord has grace notes (duration==0), the duration of the
2242             # event chord is not yet known, but the event chord was already added
2243             # with duration 0. The following correct this when we hit the real note!
2244             if voice_builder.current_duration () == 0 and n._duration > 0:
2245                 voice_builder.set_duration (n._duration)
2246
2247         # if we have a figured bass, set its voice builder to the correct position
2248         # and insert the pending figures
2249         if pending_figured_bass:
2250             try:
2251                 figured_bass_builder.jumpto (n._when)
2252             except NegativeSkip, neg:
2253                 pass
2254             for fb in pending_figured_bass:
2255                 # if a duration is given, use that, otherwise the one of the note
2256                 dur = fb.real_duration
2257                 if not dur:
2258                     dur = ev_chord.get_length ()
2259                 if not fb.duration:
2260                     fb.duration = ev_chord.get_duration ()
2261                 figured_bass_builder.add_music (fb, dur)
2262             pending_figured_bass = []
2263
2264         if pending_chordnames:
2265             try:
2266                 chordnames_builder.jumpto (n._when)
2267             except NegativeSkip, neg:
2268                 pass
2269             for cn in pending_chordnames:
2270                 # Assign the duration of the EventChord
2271                 cn.duration = ev_chord.get_duration ()
2272                 chordnames_builder.add_music (cn, ev_chord.get_length ())
2273             pending_chordnames = []
2274
2275         notations_children = n.get_typed_children (musicxml.Notations)
2276         tuplet_event = None
2277         span_events = []
2278
2279         # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
2280         # +tied | +slur | +tuplet | glissando | slide |
2281         #    ornaments | technical | articulations | dynamics |
2282         #    +fermata | arpeggiate | non-arpeggiate |
2283         #    accidental-mark | other-notation
2284         for notations in notations_children:
2285             for tuplet_event in notations.get_tuplets():
2286                 time_mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
2287                 tuplet_events.append ((ev_chord, tuplet_event, time_mod))
2288
2289             # First, close all open slurs, only then start any new slur
2290             # TODO: Record the number of the open slur to dtermine the correct
2291             #       closing slur!
2292             endslurs = [s for s in notations.get_named_children ('slur')
2293                 if s.get_type () in ('stop')]
2294             if endslurs and not inside_slur:
2295                 endslurs[0].message (_ ('Encountered closing slur, but no slur is open'))
2296             elif endslurs:
2297                 if len (endslurs) > 1:
2298                     endslurs[0].message (_ ('Cannot have two simultaneous (closing) slurs'))
2299                 # record the slur status for the next note in the loop
2300                 inside_slur = False
2301                 lily_ev = musicxml_spanner_to_lily_event (endslurs[0])
2302                 ev_chord.append (lily_ev)
2303
2304             startslurs = [s for s in notations.get_named_children ('slur')
2305                 if s.get_type () in ('start')]
2306             if startslurs and inside_slur:
2307                 startslurs[0].message (_ ('Cannot have a slur inside another slur'))
2308             elif startslurs:
2309                 if len (startslurs) > 1:
2310                     startslurs[0].message (_ ('Cannot have two simultaneous slurs'))
2311                 # record the slur status for the next note in the loop
2312                 inside_slur = True
2313                 lily_ev = musicxml_spanner_to_lily_event (startslurs[0])
2314                 ev_chord.append (lily_ev)
2315
2316
2317             if not grace:
2318                 mxl_tie = notations.get_tie ()
2319                 if mxl_tie and mxl_tie.type == 'start':
2320                     ev_chord.append (musicexp.TieEvent ())
2321                     is_tied = True
2322                 else:
2323                     is_tied = False
2324
2325             fermatas = notations.get_named_children ('fermata')
2326             for a in fermatas:
2327                 ev = musicxml_fermata_to_lily_event (a)
2328                 if ev:
2329                     ev_chord.append (ev)
2330
2331             arpeggiate = notations.get_named_children ('arpeggiate')
2332             for a in arpeggiate:
2333                 ev = musicxml_arpeggiate_to_lily_event (a)
2334                 if ev:
2335                     ev_chord.append (ev)
2336
2337             arpeggiate = notations.get_named_children ('non-arpeggiate')
2338             for a in arpeggiate:
2339                 ev = musicxml_nonarpeggiate_to_lily_event (a)
2340                 if ev:
2341                     ev_chord.append (ev)
2342
2343             glissandos = notations.get_named_children ('glissando')
2344             glissandos += notations.get_named_children ('slide')
2345             for a in glissandos:
2346                 ev = musicxml_spanner_to_lily_event (a)
2347                 if ev:
2348                     ev_chord.append (ev)
2349
2350             # accidental-marks are direct children of <notation>!
2351             for a in notations.get_named_children ('accidental-mark'):
2352                 ev = musicxml_articulation_to_lily_event (a)
2353                 if ev:
2354                     ev_chord.append (ev)
2355
2356             # Articulations can contain the following child elements:
2357             #         accent | strong-accent | staccato | tenuto |
2358             #         detached-legato | staccatissimo | spiccato |
2359             #         scoop | plop | doit | falloff | breath-mark |
2360             #         caesura | stress | unstress
2361             # Technical can contain the following child elements:
2362             #         up-bow | down-bow | harmonic | open-string |
2363             #         thumb-position | fingering | pluck | double-tongue |
2364             #         triple-tongue | stopped | snap-pizzicato | fret |
2365             #         string | hammer-on | pull-off | bend | tap | heel |
2366             #         toe | fingernails | other-technical
2367             # Ornaments can contain the following child elements:
2368             #         trill-mark | turn | delayed-turn | inverted-turn |
2369             #         shake | wavy-line | mordent | inverted-mordent |
2370             #         schleifer | tremolo | other-ornament, accidental-mark
2371             ornaments = notations.get_named_children ('ornaments')
2372             ornaments += notations.get_named_children ('articulations')
2373             ornaments += notations.get_named_children ('technical')
2374
2375             for a in ornaments:
2376                 for ch in a.get_all_children ():
2377                     ev = musicxml_articulation_to_lily_event (ch)
2378                     if ev:
2379                         ev_chord.append (ev)
2380
2381             dynamics = notations.get_named_children ('dynamics')
2382             for a in dynamics:
2383                 for ch in a.get_all_children ():
2384                     ev = musicxml_dynamics_to_lily_event (ch)
2385                     if ev:
2386                         ev_chord.append (ev)
2387
2388
2389         mxl_beams = [b for b in n.get_named_children ('beam')
2390                      if (b.get_type () in ('begin', 'end')
2391                          and b.is_primary ())]
2392         if mxl_beams and not conversion_settings.ignore_beaming:
2393             beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
2394             if beam_ev:
2395                 ev_chord.append (beam_ev)
2396                 if beam_ev.span_direction == -1: # beam and thus melisma starts here
2397                     is_beamed = True
2398                 elif beam_ev.span_direction == 1: # beam and thus melisma ends here
2399                     is_beamed = False
2400
2401         # Extract the lyrics
2402         if not rest and not ignore_lyrics:
2403             note_lyrics_processed = []
2404             note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
2405             for l in note_lyrics_elements:
2406                 if l.get_number () < 0:
2407                     for k in lyrics.keys ():
2408                         lyrics[k].append (musicxml_lyrics_to_text (l))
2409                         note_lyrics_processed.append (k)
2410                 else:
2411                     lyrics[l.number].append(musicxml_lyrics_to_text (l))
2412                     note_lyrics_processed.append (l.number)
2413             for lnr in lyrics.keys ():
2414                 if not lnr in note_lyrics_processed:
2415                     lyrics[lnr].append ("\skip4")
2416
2417     ## force trailing mm rests to be written out.
2418     voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
2419
2420     ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
2421     ly_voice = group_repeats (ly_voice)
2422
2423     seq_music = musicexp.SequentialMusic ()
2424
2425     if 'drummode' in modes_found.keys ():
2426         ## \key <pitch> barfs in drummode.
2427         ly_voice = [e for e in ly_voice
2428                     if not isinstance(e, musicexp.KeySignatureChange)]
2429
2430     seq_music.elements = ly_voice
2431     for k in lyrics.keys ():
2432         return_value.lyrics_dict[k] = musicexp.Lyrics ()
2433         return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
2434
2435
2436     if len (modes_found) > 1:
2437        error_message (_ ('cannot simultaneously have more than one mode: %s') % modes_found.keys ())
2438
2439     if options.relative:
2440         v = musicexp.RelativeMusic ()
2441         v.element = seq_music
2442         v.basepitch = first_pitch
2443         seq_music = v
2444
2445     return_value.ly_voice = seq_music
2446     for mode in modes_found.keys ():
2447         v = musicexp.ModeChangingMusicWrapper()
2448         v.element = seq_music
2449         v.mode = mode
2450         return_value.ly_voice = v
2451
2452     # create \figuremode { figured bass elements }
2453     if figured_bass_builder.has_relevant_elements:
2454         fbass_music = musicexp.SequentialMusic ()
2455         fbass_music.elements = group_repeats (figured_bass_builder.elements)
2456         v = musicexp.ModeChangingMusicWrapper()
2457         v.mode = 'figuremode'
2458         v.element = fbass_music
2459         return_value.figured_bass = v
2460
2461     # create \chordmode { chords }
2462     if chordnames_builder.has_relevant_elements:
2463         cname_music = musicexp.SequentialMusic ()
2464         cname_music.elements = group_repeats (chordnames_builder.elements)
2465         v = musicexp.ModeChangingMusicWrapper()
2466         v.mode = 'chordmode'
2467         v.element = cname_music
2468         return_value.chordnames = v
2469
2470     return return_value
2471
2472 def musicxml_id_to_lily (id):
2473     digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
2474               'Six', 'Seven', 'Eight', 'Nine', 'Ten']
2475
2476     for digit in digits:
2477         d = digits.index (digit)
2478         id = re.sub ('%d' % d, digit, id)
2479
2480     id = re.sub  ('[^a-zA-Z]', 'X', id)
2481     return id
2482
2483 def musicxml_pitch_to_lily (mxl_pitch):
2484     p = musicexp.Pitch ()
2485     p.alteration = mxl_pitch.get_alteration ()
2486     p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
2487     p.octave = mxl_pitch.get_octave () - 4
2488     return p
2489
2490 def musicxml_unpitched_to_lily (mxl_unpitched):
2491     p = None
2492     step = mxl_unpitched.get_step ()
2493     if step:
2494         p = musicexp.Pitch ()
2495         p.step = musicxml_step_to_lily (step)
2496     octave = mxl_unpitched.get_octave ()
2497     if octave and p:
2498         p.octave = octave - 4
2499     return p
2500
2501 def musicxml_restdisplay_to_lily (mxl_rest):
2502     p = None
2503     step = mxl_rest.get_step ()
2504     if step:
2505         p = musicexp.Pitch ()
2506         p.step = musicxml_step_to_lily (step)
2507     octave = mxl_rest.get_octave ()
2508     if octave and p:
2509         p.octave = octave - 4
2510     return p
2511
2512 def voices_in_part (part):
2513     """Return a Name -> Voice dictionary for PART"""
2514     part.interpret ()
2515     part.extract_voices ()
2516     voices = part.get_voices ()
2517     part_info = part.get_staff_attributes ()
2518
2519     return (voices, part_info)
2520
2521 def voices_in_part_in_parts (parts):
2522     """return a Part -> Name -> Voice dictionary"""
2523     return dict([(p.id, voices_in_part (p)) for p in parts])
2524
2525
2526 def get_all_voices (parts):
2527     all_voices = voices_in_part_in_parts (parts)
2528
2529     all_ly_voices = {}
2530     all_ly_staffinfo = {}
2531     for p, (name_voice, staff_info) in all_voices.items ():
2532
2533         part_ly_voices = {}
2534         for n, v in name_voice.items ():
2535             progress (_ ("Converting to LilyPond expressions..."))
2536             # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
2537             part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
2538
2539         all_ly_voices[p] = part_ly_voices
2540         all_ly_staffinfo[p] = staff_info
2541
2542     return (all_ly_voices, all_ly_staffinfo)
2543
2544
2545 def option_parser ():
2546     p = ly.get_option_parser (usage = _ ("musicxml2ly [OPTION]... FILE.xml"),
2547                              description =
2548 _ ("""Convert MusicXML from FILE.xml to LilyPond input.
2549 If the given filename is -, musicxml2ly reads from the command line.
2550 """), add_help_option=False)
2551
2552     p.add_option("-h", "--help",
2553                  action="help",
2554                  help=_ ("show this help and exit"))
2555
2556     p.version = ('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
2557 +
2558 _ ("""Copyright (c) 2005--2009 by
2559     Han-Wen Nienhuys <hanwen@xs4all.nl>,
2560     Jan Nieuwenhuizen <janneke@gnu.org> and
2561     Reinhold Kainhofer <reinhold@kainhofer.com>
2562 """
2563 +
2564 """
2565 This program is free software.  It is covered by the GNU General Public
2566 License and you are welcome to change it and/or distribute copies of it
2567 under certain conditions.  Invoke as `%s --warranty' for more
2568 information.""") % 'lilypond')
2569
2570     p.add_option("--version",
2571                  action="version",
2572                  help=_ ("show version number and exit"))
2573
2574     p.add_option ('-v', '--verbose',
2575                   action = "store_true",
2576                   dest = 'verbose',
2577                   help = _ ("be verbose"))
2578
2579     p.add_option ('', '--lxml',
2580                   action = "store_true",
2581                   default = False,
2582                   dest = "use_lxml",
2583                   help = _ ("use lxml.etree; uses less memory and cpu time"))
2584
2585     p.add_option ('-z', '--compressed',
2586                   action = "store_true",
2587                   dest = 'compressed',
2588                   default = False,
2589                   help = _ ("input file is a zip-compressed MusicXML file"))
2590
2591     p.add_option ('-r', '--relative',
2592                   action = "store_true",
2593                   default = True,
2594                   dest = "relative",
2595                   help = _ ("convert pitches in relative mode (default)"))
2596
2597     p.add_option ('-a', '--absolute',
2598                   action = "store_false",
2599                   dest = "relative",
2600                   help = _ ("convert pitches in absolute mode"))
2601
2602     p.add_option ('-l', '--language',
2603                   metavar = _ ("LANG"),
2604                   action = "store",
2605                   help = _ ("use a different language file 'LANG.ly' and corresponding pitch names, e.g. 'deutsch' for deutsch.ly"))
2606
2607     p.add_option ('--nd', '--no-articulation-directions',
2608                   action = "store_false",
2609                   default = True,
2610                   dest = "convert_directions",
2611                   help = _ ("do not convert directions (^, _ or -) for articulations, dynamics, etc."))
2612
2613     p.add_option ('--nrp', '--no-rest-positions',
2614                   action = "store_false",
2615                   default = True,
2616                   dest = "convert_rest_positions",
2617                   help = _ ("do not convert exact vertical positions of rests"))
2618
2619     p.add_option ('--no-beaming',
2620                   action = "store_false",
2621                   default = True,
2622                   dest = "convert_beaming",
2623                   help = _ ("do not convert beaming information, use lilypond's automatic beaming instead"))
2624
2625     p.add_option ('-o', '--output',
2626                   metavar = _ ("FILE"),
2627                   action = "store",
2628                   default = None,
2629                   type = 'string',
2630                   dest = 'output_name',
2631                   help = _ ("set output filename to FILE, stdout if -"))
2632     p.add_option_group ('',
2633                         description = (
2634             _ ("Report bugs via %s")
2635             % 'http://post.gmane.org/post.php'
2636             '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
2637     return p
2638
2639 def music_xml_voice_name_to_lily_name (part_id, name):
2640     str = "Part%sVoice%s" % (part_id, name)
2641     return musicxml_id_to_lily (str)
2642
2643 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
2644     str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
2645     return musicxml_id_to_lily (str)
2646
2647 def music_xml_figuredbass_name_to_lily_name (part_id, voicename):
2648     str = "Part%sVoice%sFiguredBass" % (part_id, voicename)
2649     return musicxml_id_to_lily (str)
2650
2651 def music_xml_chordnames_name_to_lily_name (part_id, voicename):
2652     str = "Part%sVoice%sChords" % (part_id, voicename)
2653     return musicxml_id_to_lily (str)
2654
2655 def print_voice_definitions (printer, part_list, voices):
2656     for part in part_list:
2657         part_id = part.id
2658         nv_dict = voices.get (part_id, {})
2659         for (name, voice) in nv_dict.items ():
2660             k = music_xml_voice_name_to_lily_name (part_id, name)
2661             printer.dump ('%s = ' % k)
2662             voice.ly_voice.print_ly (printer)
2663             printer.newline()
2664             if voice.chordnames:
2665                 cnname = music_xml_chordnames_name_to_lily_name (part_id, name)
2666                 printer.dump ('%s = ' % cnname )
2667                 voice.chordnames.print_ly (printer)
2668                 printer.newline()
2669             for l in voice.lyrics_order:
2670                 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
2671                 printer.dump ('%s = ' % lname )
2672                 voice.lyrics_dict[l].print_ly (printer)
2673                 printer.newline()
2674             if voice.figured_bass:
2675                 fbname = music_xml_figuredbass_name_to_lily_name (part_id, name)
2676                 printer.dump ('%s = ' % fbname )
2677                 voice.figured_bass.print_ly (printer)
2678                 printer.newline()
2679
2680
2681 def uniq_list (l):
2682     return dict ([(elt,1) for elt in l]).keys ()
2683
2684 # format the information about the staff in the form
2685 #     [staffid,
2686 #         [
2687 #            [voiceid1, [lyricsid11, lyricsid12,...], figuredbassid1],
2688 #            [voiceid2, [lyricsid21, lyricsid22,...], figuredbassid2],
2689 #            ...
2690 #         ]
2691 #     ]
2692 # raw_voices is of the form [(voicename, lyricsids, havefiguredbass)*]
2693 def format_staff_info (part_id, staff_id, raw_voices):
2694     voices = []
2695     for (v, lyricsids, figured_bass, chordnames) in raw_voices:
2696         voice_name = music_xml_voice_name_to_lily_name (part_id, v)
2697         voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
2698                    for l in lyricsids]
2699         figured_bass_name = ''
2700         if figured_bass:
2701             figured_bass_name = music_xml_figuredbass_name_to_lily_name (part_id, v)
2702         chordnames_name = ''
2703         if chordnames:
2704             chordnames_name = music_xml_chordnames_name_to_lily_name (part_id, v)
2705         voices.append ([voice_name, voice_lyrics, figured_bass_name, chordnames_name])
2706     return [staff_id, voices]
2707
2708 def update_score_setup (score_structure, part_list, voices):
2709
2710     for part_definition in part_list:
2711         part_id = part_definition.id
2712         nv_dict = voices.get (part_id)
2713         if not nv_dict:
2714             error_message (_ ('unknown part in part-list: %s') % part_id)
2715             continue
2716
2717         staves = reduce (lambda x,y: x+ y,
2718                 [voice.voicedata._staves.keys ()
2719                  for voice in nv_dict.values ()],
2720                 [])
2721         staves_info = []
2722         if len (staves) > 1:
2723             staves_info = []
2724             staves = uniq_list (staves)
2725             staves.sort ()
2726             for s in staves:
2727                 thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2728                     for (voice_name, voice) in nv_dict.items ()
2729                     if voice.voicedata._start_staff == s]
2730                 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
2731         else:
2732             thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2733                 for (voice_name, voice) in nv_dict.items ()]
2734             staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
2735         score_structure.set_part_information (part_id, staves_info)
2736
2737 # Set global values in the \layout block, like auto-beaming etc.
2738 def update_layout_information ():
2739     if not conversion_settings.ignore_beaming and layout_information:
2740         layout_information.set_context_item ('Score', 'autoBeaming = ##f')
2741
2742 def print_ly_preamble (printer, filename):
2743     printer.dump_version ()
2744     printer.print_verbatim ('%% automatically converted from %s\n' % filename)
2745
2746 def print_ly_additional_definitions (printer, filename):
2747     if needed_additional_definitions:
2748         printer.newline ()
2749         printer.print_verbatim ('%% additional definitions required by the score:')
2750         printer.newline ()
2751     for a in set(needed_additional_definitions):
2752         printer.print_verbatim (additional_definitions.get (a, ''))
2753         printer.newline ()
2754     printer.newline ()
2755
2756 # Read in the tree from the given I/O object (either file or string) and
2757 # demarshall it using the classes from the musicxml.py file
2758 def read_xml (io_object, use_lxml):
2759     if use_lxml:
2760         import lxml.etree
2761         tree = lxml.etree.parse (io_object)
2762         mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
2763         return mxl_tree
2764     else:
2765         from xml.dom import minidom, Node
2766         doc = minidom.parse(io_object)
2767         node = doc.documentElement
2768         return musicxml.minidom_demarshal_node (node)
2769     return None
2770
2771
2772 def read_musicxml (filename, compressed, use_lxml):
2773     raw_string = None
2774     if compressed:
2775         if filename == "-":
2776              progress (_ ("Input is compressed, extracting raw MusicXML data from stdin") )
2777              z = zipfile.ZipFile (sys.stdin)
2778         else:
2779             progress (_ ("Input file %s is compressed, extracting raw MusicXML data") % filename)
2780             z = zipfile.ZipFile (filename, "r")
2781         container_xml = z.read ("META-INF/container.xml")
2782         if not container_xml:
2783             return None
2784         container = read_xml (StringIO.StringIO (container_xml), use_lxml)
2785         if not container:
2786             return None
2787         rootfiles = container.get_maybe_exist_named_child ('rootfiles')
2788         if not rootfiles:
2789             return None
2790         rootfile_list = rootfiles.get_named_children ('rootfile')
2791         mxml_file = None
2792         if len (rootfile_list) > 0:
2793             mxml_file = getattr (rootfile_list[0], 'full-path', None)
2794         if mxml_file:
2795             raw_string = z.read (mxml_file)
2796
2797     if raw_string:
2798         io_object = StringIO.StringIO (raw_string)
2799     elif filename == "-":
2800         io_object = sys.stdin
2801     else:
2802         io_object = filename
2803
2804     return read_xml (io_object, use_lxml)
2805
2806
2807 def convert (filename, options):
2808     if filename == "-":
2809         progress (_ ("Reading MusicXML from Standard input ...") )
2810     else:
2811         progress (_ ("Reading MusicXML from %s ...") % filename)
2812
2813     tree = read_musicxml (filename, options.compressed, options.use_lxml)
2814     score_information = extract_score_information (tree)
2815     paper_information = extract_paper_information (tree)
2816
2817     parts = tree.get_typed_children (musicxml.Part)
2818     (voices, staff_info) = get_all_voices (parts)
2819
2820     score = None
2821     mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
2822     if mxl_pl:
2823         score = extract_score_structure (mxl_pl, staff_info)
2824         part_list = mxl_pl.get_named_children ("score-part")
2825
2826     # score information is contained in the <work>, <identification> or <movement-title> tags
2827     update_score_setup (score, part_list, voices)
2828     # After the conversion, update the list of settings for the \layout block
2829     update_layout_information ()
2830
2831     if not options.output_name:
2832         options.output_name = os.path.basename (filename)
2833         options.output_name = os.path.splitext (options.output_name)[0]
2834     elif re.match (".*\.ly", options.output_name):
2835         options.output_name = os.path.splitext (options.output_name)[0]
2836
2837
2838     #defs_ly_name = options.output_name + '-defs.ly'
2839     if (options.output_name == "-"):
2840       output_ly_name = 'Standard output'
2841     else:
2842       output_ly_name = options.output_name + '.ly'
2843
2844     progress (_ ("Output to `%s'") % output_ly_name)
2845     printer = musicexp.Output_printer()
2846     #progress (_ ("Output to `%s'") % defs_ly_name)
2847     if (options.output_name == "-"):
2848       printer.set_file (codecs.getwriter ("utf-8")(sys.stdout))
2849     else:
2850       printer.set_file (codecs.open (output_ly_name, 'wb', encoding='utf-8'))
2851     print_ly_preamble (printer, filename)
2852     print_ly_additional_definitions (printer, filename)
2853     if score_information:
2854         score_information.print_ly (printer)
2855     if paper_information:
2856         paper_information.print_ly (printer)
2857     if layout_information:
2858         layout_information.print_ly (printer)
2859     print_voice_definitions (printer, part_list, voices)
2860
2861     printer.newline ()
2862     printer.dump ("% The score definition")
2863     printer.newline ()
2864     score.print_ly (printer)
2865     printer.newline ()
2866
2867     return voices
2868
2869 def get_existing_filename_with_extension (filename, ext):
2870     if os.path.exists (filename):
2871         return filename
2872     newfilename = filename + "." + ext
2873     if os.path.exists (newfilename):
2874         return newfilename;
2875     newfilename = filename + ext
2876     if os.path.exists (newfilename):
2877         return newfilename;
2878     return ''
2879
2880 def main ():
2881     opt_parser = option_parser()
2882
2883     global options
2884     (options, args) = opt_parser.parse_args ()
2885     if not args:
2886         opt_parser.print_usage()
2887         sys.exit (2)
2888
2889     if options.language:
2890         musicexp.set_pitch_language (options.language)
2891         needed_additional_definitions.append (options.language)
2892         additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
2893     conversion_settings.ignore_beaming = not options.convert_beaming
2894
2895     # Allow the user to leave out the .xml or xml on the filename
2896     basefilename = args[0].decode('utf-8')
2897     if basefilename == "-": # Read from stdin
2898         basefilename = "-"
2899     else:
2900         filename = get_existing_filename_with_extension (basefilename, "xml")
2901         if not filename:
2902             filename = get_existing_filename_with_extension (basefilename, "mxl")
2903             options.compressed = True
2904     if filename and filename.endswith ("mxl"):
2905         options.compressed = True
2906
2907     if filename and (filename == "-" or os.path.exists (filename)):
2908         voices = convert (filename, options)
2909     else:
2910         progress (_ ("Unable to find input file %s") % basefilename)
2911
2912 if __name__ == '__main__':
2913     main()