2 # -*- coding: utf-8 -*-
22 from rational import Rational
24 # Store command-line options in a global variable, so we can access them everythwere
27 class Conversion_Settings:
29 self.ignore_beaming = False
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 ()
38 ly.stderr_write (str + '\n')
41 def error_message (str):
42 ly.stderr_write (str + '\n')
45 needed_additional_definitions = []
46 additional_definitions = {
48 "snappizzicato": """#(define-markup-command (snappizzicato layout props) ()
49 (interpret-markup layout props
51 (ly:stencil-translate-axis
53 (make-circle-stencil 0.7 0.1 #f)
55 (list 'draw-line 0.1 0 0.1 0 1)
56 '(-0.1 . 0.1) '(0.1 . 1)))
59 "eyeglasses": """eyeglassesps = #"0.15 setlinewidth
65 2.20 0.70 0.50 0 361 arc
67 1.45 0.85 0.30 0 180 arc
71 0.92 2.26 1.30 2.40 1.15 1.70 curveto
75 3.42 2.26 3.80 2.40 3.65 1.70 curveto
77 eyeglasses = \markup { \with-dimensions #'(0 . 4.4) #'(0 . 2.5) \postscript #eyeglassesps }""",
79 "tuplet-note-wrapper": """ % a formatter function, which is simply a wrapper around an existing
80 % tuplet formatter function. It takes the value returned by the given
81 % function and appends a note of given length.
82 #(define-public ((tuplet-number::append-note-wrapper function note) grob)
83 (let* ((txt (if function (function grob) #f)))
85 (markup txt #:fontsize -5 #:note note UP)
86 (markup #:fontsize -5 #:note note UP)
91 "tuplet-non-default-denominator": """#(define ((tuplet-number::non-default-tuplet-denominator-text denominator) grob)
92 (number->string (if denominator
94 (ly:event-property (event-cause grob) 'denominator))))
97 "tuplet-non-default-fraction": """#(define ((tuplet-number::non-default-tuplet-fraction-text denominator numerator) grob)
98 (let* ((ev (event-cause grob))
99 (den (if denominator denominator (ly:event-property ev 'denominator)))
100 (num (if numerator numerator (ly:event-property ev 'numerator))))
101 (format "~a:~a" den num)))
104 "compound-time-signature": """%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
105 % Formatting of (possibly complex) compound time signatures
106 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108 #(define-public (insert-markups l m)
109 (let* ((ll (reverse l)))
110 (let join-markups ((markups (list (car ll)))
111 (remaining (cdr ll)))
112 (if (pair? remaining)
113 (join-markups (cons (car remaining) (cons m markups)) (cdr remaining))
116 % Use a centered-column inside a left-column, because the centered column
117 % moves its reference point to the center, which the left-column undoes.
118 % The center-column also aligns its contented centered, which is not undone...
119 #(define-public (format-time-fraction time-sig-fraction)
120 (let* ((revargs (reverse (map number->string time-sig-fraction)))
122 (nums (reverse (cdr revargs))))
123 (make-override-markup '(baseline-skip . 0)
125 (make-left-column-markup (list
126 (make-center-column-markup (list
127 (make-line-markup (insert-markups nums "+"))
130 #(define-public (format-complex-compound-time time-sig)
131 (let* ((sigs (map format-time-fraction time-sig)))
132 (make-override-markup '(baseline-skip . 0)
135 (insert-markups sigs (make-vcenter-markup "+")))))))
137 #(define-public (format-compound-time time-sig)
139 ((not (pair? time-sig)) (null-markup))
140 ((pair? (car time-sig)) (format-complex-compound-time time-sig))
141 (else (format-time-fraction time-sig))))
144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
145 % Measure length calculation of (possibly complex) compound time signatures
146 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148 #(define-public (calculate-time-fraction time-sig-fraction)
149 (let* ((revargs (reverse time-sig-fraction))
151 (nums (cdr revargs)))
152 (ly:make-moment (apply + nums) den)))
154 #(define-public (calculate-complex-compound-time time-sig)
155 (let* ((sigs (map calculate-time-fraction time-sig)))
156 (let add-moment ((moment ZERO-MOMENT)
158 (if (pair? remaining)
159 (add-moment (ly:moment-add moment (car remaining)) (cdr remaining))
162 #(define-public (calculate-compound-measure-length time-sig)
164 ((not (pair? time-sig)) (ly:make-moment 4 4))
165 ((pair? (car time-sig)) (calculate-complex-compound-time time-sig))
166 (else (calculate-time-fraction time-sig))))
169 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
171 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
173 #(define-public (calculate-compound-base-beat-full time-sig)
174 (let* ((den (map last time-sig)))
177 #(define-public (calculate-compound-base-beat time-sig)
178 (ly:make-moment 1 (cond
179 ((not (pair? time-sig)) 4)
180 ((pair? (car time-sig)) (calculate-compound-base-beat-full time-sig))
181 (else (calculate-compound-base-beat-full (list time-sig))))))
184 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
185 % The music function to set the complex time signature
186 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
189 #(define-music-function (parser location args) (pair?)
190 (let ((mlen (calculate-compound-measure-length args))
191 (beat (calculate-compound-base-beat args)))
193 \once \override Staff.TimeSignature #'stencil = #ly:text-interface::print
194 \once \override Staff.TimeSignature #'text = #(format-compound-time $args)
195 % \set Staff.beatGrouping = #(reverse (cdr (reverse $args)))
196 \set Timing.measureLength = $mlen
197 \set Timing.timeSignatureFraction = #(cons (ly:moment-main-numerator $mlen)
198 (ly:moment-main-denominator $mlen))
199 \set Timing.beatLength = $beat
201 % TODO: Implement beatGrouping and auto-beam-settings!!!
206 def round_to_two_digits (val):
207 return round (val * 100) / 100
209 def extract_paper_information (tree):
210 paper = musicexp.Paper ()
211 defaults = tree.get_maybe_exist_named_child ('defaults')
215 scaling = defaults.get_maybe_exist_named_child ('scaling')
217 mm = scaling.get_named_child ('millimeters')
218 mm = string.atof (mm.get_text ())
219 tn = scaling.get_maybe_exist_named_child ('tenths')
220 tn = string.atof (tn.get_text ())
222 paper.global_staff_size = mm * 72.27 / 25.4
223 # We need the scaling (i.e. the size of staff tenths for everything!
227 def from_tenths (txt):
228 return round_to_two_digits (string.atof (txt) * tenths / 10)
229 def set_paper_variable (varname, parent, element_name):
230 el = parent.get_maybe_exist_named_child (element_name)
231 if el: # Convert to cm from tenths
232 setattr (paper, varname, from_tenths (el.get_text ()))
234 pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
236 # TODO: How can one have different margins for even and odd pages???
237 set_paper_variable ("page_height", pagelayout, 'page-height')
238 set_paper_variable ("page_width", pagelayout, 'page-width')
240 pmargins = pagelayout.get_named_children ('page-margins')
242 set_paper_variable ("left_margin", pm, 'left-margin')
243 set_paper_variable ("right_margin", pm, 'right-margin')
244 set_paper_variable ("bottom_margin", pm, 'bottom-margin')
245 set_paper_variable ("top_margin", pm, 'top-margin')
247 systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
249 sl = systemlayout.get_maybe_exist_named_child ('system-margins')
251 set_paper_variable ("system_left_margin", sl, 'left-margin')
252 set_paper_variable ("system_right_margin", sl, 'right-margin')
253 set_paper_variable ("system_distance", systemlayout, 'system-distance')
254 set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
256 stafflayout = defaults.get_named_children ('staff-layout')
257 for sl in stafflayout:
258 nr = getattr (sl, 'number', 1)
259 dist = sl.get_named_child ('staff-distance')
260 #TODO: the staff distance needs to be set in the Staff context!!!
262 # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
263 appearance = defaults.get_named_child ('appearance')
265 lws = appearance.get_named_children ('line-width')
267 # Possible types are: beam, bracket, dashes,
268 # enclosure, ending, extend, heavy barline, leger,
269 # light barline, octave shift, pedal, slur middle, slur tip,
270 # staff, stem, tie middle, tie tip, tuplet bracket, and wedge
272 w = from_tenths (lw.get_text ())
273 # TODO: Do something with these values!
274 nss = appearance.get_named_children ('note-size')
276 # Possible types are: cue, grace and large
278 sz = from_tenths (ns.get_text ())
279 # TODO: Do something with these values!
280 # <other-appearance> elements have no specified meaning
282 rawmusicfont = defaults.get_named_child ('music-font')
284 # TODO: Convert the font
286 rawwordfont = defaults.get_named_child ('word-font')
288 # TODO: Convert the font
290 rawlyricsfonts = defaults.get_named_children ('lyric-font')
291 for lyricsfont in rawlyricsfonts:
292 # TODO: Convert the font
299 # score information is contained in the <work>, <identification> or <movement-title> tags
300 # extract those into a hash, indexed by proper lilypond header attributes
301 def extract_score_information (tree):
302 header = musicexp.Header ()
303 def set_if_exists (field, value):
305 header.set_field (field, musicxml.escape_ly_output_string (value))
307 work = tree.get_maybe_exist_named_child ('work')
309 set_if_exists ('title', work.get_work_title ())
310 set_if_exists ('worknumber', work.get_work_number ())
311 set_if_exists ('opus', work.get_opus ())
313 movement_title = tree.get_maybe_exist_named_child ('movement-title')
315 set_if_exists ('title', movement_title.get_text ())
317 identifications = tree.get_named_children ('identification')
318 for ids in identifications:
319 set_if_exists ('copyright', ids.get_rights ())
320 set_if_exists ('composer', ids.get_composer ())
321 set_if_exists ('arranger', ids.get_arranger ())
322 set_if_exists ('editor', ids.get_editor ())
323 set_if_exists ('poet', ids.get_poet ())
325 set_if_exists ('tagline', ids.get_encoding_software ())
326 set_if_exists ('encodingsoftware', ids.get_encoding_software ())
327 set_if_exists ('encodingdate', ids.get_encoding_date ())
328 set_if_exists ('encoder', ids.get_encoding_person ())
329 set_if_exists ('encodingdescription', ids.get_encoding_description ())
331 set_if_exists ('texidoc', ids.get_file_description ());
333 # Finally, apply the required compatibility modes
334 # Some applications created wrong MusicXML files, so we need to
335 # apply some compatibility mode, e.g. ignoring some features/tags
337 software = ids.get_encoding_software_list ()
339 # Case 1: "Sibelius 5.1" with the "Dolet 3.4 for Sibelius" plugin
340 # is missing all beam ends => ignore all beaming information
341 if "Dolet 3.4 for Sibelius" in software:
342 conversion_settings.ignore_beaming = True
343 progress (_ ("Encountered file created by Dolet 3.4 for Sibelius, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
344 # ditto for Dolet 3.5
345 if "Dolet 3.5 for Sibelius" in software:
346 conversion_settings.ignore_beaming = True
347 progress (_ ("Encountered file created by Dolet 3.5 for Sibelius, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
348 if "Noteworthy Composer" in software:
349 conversion_settings.ignore_beaming = True
350 progress (_ ("Encountered file created by Noteworthy Composer's nwc2xml, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
351 # TODO: Check for other unsupported features
360 return len (self.start) + len (self.end) == 0
361 def add_start (self, g):
362 self.start[getattr (g, 'number', "1")] = g
363 def add_end (self, g):
364 self.end[getattr (g, 'number', "1")] = g
365 def print_ly (self, printer):
366 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
367 def ly_expression (self):
368 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
371 def staff_attributes_to_string_tunings (mxl_attr):
372 details = mxl_attr.get_maybe_exist_named_child ('staff-details')
376 staff_lines = details.get_maybe_exist_named_child ('staff-lines')
378 lines = string.atoi (staff_lines.get_text ())
381 staff_tunings = details.get_named_children ('staff-tuning')
382 for i in staff_tunings:
386 line = string.atoi (i.line) - 1
391 step = i.get_named_child (u'tuning-step')
392 step = step.get_text ().strip ()
393 p.step = musicxml_step_to_lily (step)
395 octave = i.get_named_child (u'tuning-octave')
396 octave = octave.get_text ().strip ()
397 p.octave = int (octave) - 4
399 alter = i.get_named_child (u'tuning-alter')
401 p.alteration = int (alter.get_text ().strip ())
402 # lilypond seems to use the opposite ordering than MusicXML...
408 def staff_attributes_to_lily_staff (mxl_attr):
410 return musicexp.Staff ()
412 (staff_id, attributes) = mxl_attr.items ()[0]
414 # distinguish by clef:
415 # percussion (percussion and rhythmic), tab, and everything else
417 clef = attributes.get_maybe_exist_named_child ('clef')
419 sign = clef.get_maybe_exist_named_child ('sign')
421 clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
424 details = attributes.get_named_children ('staff-details')
426 staff_lines = d.get_maybe_exist_named_child ('staff-lines')
428 lines = string.atoi (staff_lines.get_text ())
431 if clef_sign == "percussion" and lines == 1:
432 staff = musicexp.RhythmicStaff ()
433 elif clef_sign == "percussion":
434 staff = musicexp.DrumStaff ()
435 # staff.drum_style_table = ???
436 elif clef_sign == "tab":
437 staff = musicexp.TabStaff ()
438 staff.string_tunings = staff_attributes_to_string_tunings (attributes)
439 # staff.tablature_format = ???
441 # TODO: Handle case with lines <> 5!
442 staff = musicexp.Staff ()
447 def extract_score_structure (part_list, staffinfo):
448 score = musicexp.Score ()
449 structure = musicexp.StaffGroup (None)
450 score.set_contents (structure)
455 def read_score_part (el):
456 if not isinstance (el, musicxml.Score_part):
458 # Depending on the attributes of the first measure, we create different
459 # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
460 staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
464 partname = el.get_maybe_exist_named_child ('part-name')
465 # Finale gives unnamed parts the name "MusicXML Part" automatically!
466 if partname and partname.get_text() != "MusicXML Part":
467 staff.instrument_name = partname.get_text ()
468 if el.get_maybe_exist_named_child ('part-abbreviation'):
469 staff.short_instrument_name = el.get_maybe_exist_named_child ('part-abbreviation').get_text ()
470 # TODO: Read in the MIDI device / instrument
473 def read_score_group (el):
474 if not isinstance (el, musicxml.Part_group):
476 group = musicexp.StaffGroup ()
477 if hasattr (el, 'number'):
480 #currentgroups_dict[id] = group
481 #currentgroups.append (id)
482 if el.get_maybe_exist_named_child ('group-name'):
483 group.instrument_name = el.get_maybe_exist_named_child ('group-name').get_text ()
484 if el.get_maybe_exist_named_child ('group-abbreviation'):
485 group.short_instrument_name = el.get_maybe_exist_named_child ('group-abbreviation').get_text ()
486 if el.get_maybe_exist_named_child ('group-symbol'):
487 group.symbol = el.get_maybe_exist_named_child ('group-symbol').get_text ()
488 if el.get_maybe_exist_named_child ('group-barline'):
489 group.spanbar = el.get_maybe_exist_named_child ('group-barline').get_text ()
493 parts_groups = part_list.get_all_children ()
495 # the start/end group tags are not necessarily ordered correctly and groups
496 # might even overlap, so we can't go through the children sequentially!
498 # 1) Replace all Score_part objects by their corresponding Staff objects,
499 # also collect all group start/stop points into one PartGroupInfo object
501 group_info = PartGroupInfo ()
502 for el in parts_groups:
503 if isinstance (el, musicxml.Score_part):
504 if not group_info.is_empty ():
505 staves.append (group_info)
506 group_info = PartGroupInfo ()
507 staff = read_score_part (el)
509 staves.append (staff)
510 elif isinstance (el, musicxml.Part_group):
511 if el.type == "start":
512 group_info.add_start (el)
513 elif el.type == "stop":
514 group_info.add_end (el)
515 if not group_info.is_empty ():
516 staves.append (group_info)
518 # 2) Now, detect the groups:
521 while pos < len (staves):
523 if isinstance (el, PartGroupInfo):
525 if len (group_starts) > 0:
526 prev_start = group_starts[-1]
527 elif len (el.end) > 0: # no group to end here
529 if len (el.end) > 0: # closes an existing group
530 ends = el.end.keys ()
531 prev_started = staves[prev_start].start.keys ()
533 intersection = filter(lambda x:x in ends, prev_started)
534 if len (intersection) > 0:
535 grpid = intersection[0]
537 # Close the last started group
538 grpid = staves[prev_start].start.keys () [0]
539 # Find the corresponding closing tag and remove it!
542 while j < len (staves) and not foundclosing:
543 if isinstance (staves[j], PartGroupInfo) and staves[j].end.has_key (grpid):
545 del staves[j].end[grpid]
546 if staves[j].is_empty ():
549 grpobj = staves[prev_start].start[grpid]
550 group = read_score_group (grpobj)
551 # remove the id from both the start and end
552 if el.end.has_key (grpid):
554 del staves[prev_start].start[grpid]
557 # replace the staves with the whole group
558 for j in staves[(prev_start + 1):pos]:
559 group.append_staff (j)
560 del staves[(prev_start + 1):pos]
561 staves.insert (prev_start + 1, group)
562 # reset pos so that we continue at the correct position
564 # remove an empty start group
565 if staves[prev_start].is_empty ():
566 del staves[prev_start]
567 group_starts.remove (prev_start)
569 elif len (el.start) > 0: # starts new part groups
570 group_starts.append (pos)
573 if len (staves) == 1:
576 structure.append_staff (i)
580 def musicxml_duration_to_lily (mxl_note):
581 # if the note has no Type child, then that method returns None. In that case,
582 # use the <duration> tag instead. If that doesn't exist, either -> Error
583 dur = mxl_note.get_duration_info ()
585 d = musicexp.Duration ()
586 d.duration_log = dur[0]
588 # Grace notes by specification have duration 0, so no time modification
589 # factor is possible. It even messes up the output with *0/1
590 if not mxl_note.get_maybe_exist_typed_child (musicxml.Grace):
591 d.factor = mxl_note._duration / d.get_length ()
595 if mxl_note._duration > 0:
596 return rational_to_lily_duration (mxl_note._duration)
598 mxl_note.message (_ ("Encountered note at %s without type and duration (=%s)") % (mxl_note.start, mxl_note._duration) )
602 def rational_to_lily_duration (rational_len):
603 d = musicexp.Duration ()
605 rational_len.normalize_self ()
606 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)
608 # Duration of the form 1/2^n or 3/2^n can be converted to a simple lilypond duration
609 if (d_log >= 0 and rational_len.numerator() in (1,3,5,7) ):
610 # account for the dots!
611 d.dots = (rational_len.numerator()-1)/2
612 d.duration_log = d_log - d.dots
614 d.duration_log = d_log
615 d.factor = Rational (rational_len.numerator ())
617 error_message (_ ("Encountered rational duration with denominator %s, "
618 "unable to convert to lilypond duration") %
619 rational_len.denominator ())
620 # TODO: Test the above error message
625 def musicxml_partial_to_lily (partial_len):
627 p = musicexp.Partial ()
628 p.partial = rational_to_lily_duration (partial_len)
633 # Detect repeats and alternative endings in the chord event list (music_list)
634 # and convert them to the corresponding musicexp objects, containing nested
636 def group_repeats (music_list):
637 repeat_replaced = True
640 # Walk through the list of expressions, looking for repeat structure
641 # (repeat start/end, corresponding endings). If we find one, try to find the
642 # last event of the repeat, replace the whole structure and start over again.
643 # For nested repeats, as soon as we encounter another starting repeat bar,
644 # treat that one first, and start over for the outer repeat.
645 while repeat_replaced and i < 100:
647 repeat_start = -1 # position of repeat start / end
648 repeat_end = -1 # position of repeat start / end
650 ending_start = -1 # position of current ending start
651 endings = [] # list of already finished endings
653 last = len (music_list) - 1
654 repeat_replaced = False
656 while pos < len (music_list) and not repeat_replaced:
658 repeat_finished = False
659 if isinstance (e, RepeatMarker):
660 if not repeat_times and e.times:
661 repeat_times = e.times
662 if e.direction == -1:
664 repeat_finished = True
670 elif e.direction == 1:
676 elif isinstance (e, EndingMarker):
677 if e.direction == -1:
683 elif e.direction == 1:
686 endings.append ([ending_start, pos])
689 elif not isinstance (e, musicexp.BarLine):
690 # As soon as we encounter an element when repeat start and end
691 # is set and we are not inside an alternative ending,
692 # this whole repeat structure is finished => replace it
693 if repeat_start >= 0 and repeat_end > 0 and ending_start < 0:
694 repeat_finished = True
696 # Finish off all repeats without explicit ending bar (e.g. when
697 # we convert only one page of a multi-page score with repeats)
698 if pos == last and repeat_start >= 0:
699 repeat_finished = True
703 if ending_start >= 0:
704 endings.append ([ending_start, pos])
708 # We found the whole structure replace it!
709 r = musicexp.RepeatedMusic ()
710 if repeat_times <= 0:
712 r.repeat_count = repeat_times
713 # don't erase the first element for "implicit" repeats (i.e. no
714 # starting repeat bars at the very beginning)
715 start = repeat_start+1
716 if repeat_start == music_start:
718 r.set_music (music_list[start:repeat_end])
719 for (start, end) in endings:
720 s = musicexp.SequentialMusic ()
721 s.elements = music_list[start+1:end]
723 del music_list[repeat_start:final_marker+1]
724 music_list.insert (repeat_start, r)
725 repeat_replaced = True
727 # TODO: Implement repeats until the end without explicit ending bar
731 # Extract the settings for tuplets from the <notations><tuplet> and the
732 # <time-modification> elements of the note:
733 def musicxml_tuplet_to_lily (tuplet_elt, time_modification):
734 tsm = musicexp.TimeScaledMusic ()
736 if time_modification:
737 fraction = time_modification.get_fraction ()
738 tsm.numerator = fraction[0]
739 tsm.denominator = fraction[1]
742 normal_type = tuplet_elt.get_normal_type ()
743 if not normal_type and time_modification:
744 normal_type = time_modification.get_normal_type ()
745 if not normal_type and time_modification:
746 note = time_modification.get_parent ()
748 normal_type = note.get_duration_info ()
750 normal_note = musicexp.Duration ()
751 (normal_note.duration_log, normal_note.dots) = normal_type
752 tsm.normal_type = normal_note
754 actual_type = tuplet_elt.get_actual_type ()
756 actual_note = musicexp.Duration ()
757 (actual_note.duration_log, actual_note.dots) = normal_type
758 tsm.actual_type = actual_note
760 # Obtain non-default nrs of notes from the tuplet object!
761 tsm.display_numerator = tuplet_elt.get_normal_nr ()
762 tsm.display_denominator = tuplet_elt.get_actual_nr ()
765 if hasattr (tuplet_elt, 'bracket') and tuplet_elt.bracket == "no":
766 tsm.display_bracket = None
767 elif hasattr (tuplet_elt, 'line-shape') and getattr (tuplet_elt, 'line-shape') == "curved":
768 tsm.display_bracket = "curved"
770 tsm.display_bracket = "bracket"
772 display_values = {"none": None, "actual": "actual", "both": "both"}
773 if hasattr (tuplet_elt, "show-number"):
774 tsm.display_number = display_values.get (getattr (tuplet_elt, "show-number"), "actual")
775 if tsm.display_number == "actual" and tsm.display_denominator:
776 needed_additional_definitions.append ("tuplet-non-default-denominator")
777 elif tsm.display_number == "both" and (tsm.display_numerator or tsm.display_denominator):
778 needed_additional_definitions.append ("tuplet-non-default-fraction")
780 if hasattr (tuplet_elt, "show-type"):
781 if getattr (tuplet_elt, "show-type") == "actual":
782 needed_additional_definitions.append ("tuplet-note-wrapper")
783 tsm.display_type = display_values.get (getattr (tuplet_elt, "show-type"), None)
788 def group_tuplets (music_list, events):
791 """Collect Musics from
792 MUSIC_LIST demarcated by EVENTS_LIST in TimeScaledMusic objects.
800 for (ev_chord, tuplet_elt, time_modification) in events:
801 while (j < len (music_list)):
802 if music_list[j] == ev_chord:
806 if hasattr (tuplet_elt, 'number'):
807 nr = getattr (tuplet_elt, 'number')
808 if tuplet_elt.type == 'start':
809 tuplet_object = musicxml_tuplet_to_lily (tuplet_elt, time_modification)
810 tuplet_info = [j, None, tuplet_object]
811 indices.append (tuplet_info)
812 brackets[nr] = tuplet_info
813 elif tuplet_elt.type == 'stop':
814 bracket_info = brackets.get (nr, None)
816 bracket_info[1] = j # Set the ending position to j
821 for (i1, i2, tsm) in indices:
825 new_list.extend (music_list[last:i1])
826 seq = musicexp.SequentialMusic ()
828 seq.elements = music_list[i1:last]
832 new_list.append (tsm)
833 #TODO: Handle nested tuplets!!!!
835 new_list.extend (music_list[last:])
839 def musicxml_clef_to_lily (attributes):
840 change = musicexp.ClefChange ()
841 (change.type, change.position, change.octave) = attributes.get_clef_information ()
844 def musicxml_time_to_lily (attributes):
845 sig = attributes.get_time_signature ()
848 change = musicexp.TimeSignatureChange()
849 change.fractions = sig
850 if (len(sig) != 2) or isinstance (sig[0], list):
851 needed_additional_definitions.append ("compound-time-signature")
853 time_elm = attributes.get_maybe_exist_named_child ('time')
854 if time_elm and hasattr (time_elm, 'symbol'):
855 change.style = { 'single-number': "'single-digit",
858 'normal': "'()"}.get (time_elm.symbol, "'()")
862 # TODO: Handle senza-misura measures
863 # TODO: Handle hidden time signatures (print-object="no")
864 # TODO: What shall we do if the symbol clashes with the sig? e.g. "cut"
865 # with 3/8 or "single-number" with (2+3)/8 or 3/8+2/4?
869 def musicxml_key_to_lily (attributes):
870 key_sig = attributes.get_key_signature ()
871 if not key_sig or not (isinstance (key_sig, list) or isinstance (key_sig, tuple)):
872 error_message (_ ("Unable to extract key signature!"))
875 change = musicexp.KeySignatureChange()
877 if len (key_sig) == 2 and not isinstance (key_sig[0], list):
878 # standard key signature, (fifths, mode)
879 (fifths, mode) = key_sig
882 start_pitch = musicexp.Pitch ()
883 start_pitch.octave = 0
897 start_pitch.alteration = a
899 error_message (_ ("unknown mode %s, expecting 'major' or 'minor' "
900 "or a church mode!") % mode)
902 fifth = musicexp.Pitch()
908 for x in range (fifths):
909 start_pitch = start_pitch.transposed (fifth)
910 change.tonic = start_pitch
913 # Non-standard key signature of the form [[step,alter<,octave>],...]
914 change.non_standard_alterations = key_sig
917 def musicxml_transpose_to_lily (attributes):
918 transpose = attributes.get_transposition ()
922 shift = musicexp.Pitch ()
923 octave_change = transpose.get_maybe_exist_named_child ('octave-change')
925 shift.octave = string.atoi (octave_change.get_text ())
926 chromatic_shift = string.atoi (transpose.get_named_child ('chromatic').get_text ())
927 chromatic_shift_normalized = chromatic_shift % 12;
928 (shift.step, shift.alteration) = [
929 (0,0), (0,1), (1,0), (2,-1), (2,0),
930 (3,0), (3,1), (4,0), (5,-1), (5,0),
931 (6,-1), (6,0)][chromatic_shift_normalized];
933 shift.octave += (chromatic_shift - chromatic_shift_normalized) / 12
935 diatonic = transpose.get_maybe_exist_named_child ('diatonic')
937 diatonic_step = string.atoi (diatonic.get_text ()) % 7
938 if diatonic_step != shift.step:
939 # We got the alter incorrect!
940 old_semitones = shift.semitones ()
941 shift.step = diatonic_step
942 new_semitones = shift.semitones ()
943 shift.alteration += old_semitones - new_semitones
945 transposition = musicexp.Transposition ()
946 transposition.pitch = musicexp.Pitch ().transposed (shift)
950 def musicxml_attributes_to_lily (attrs):
953 'clef': musicxml_clef_to_lily,
954 'time': musicxml_time_to_lily,
955 'key': musicxml_key_to_lily,
956 'transpose': musicxml_transpose_to_lily,
958 for (k, func) in attr_dispatch.items ():
959 children = attrs.get_named_children (k)
967 class Marker (musicexp.Music):
971 def print_ly (self, printer):
972 ly.stderr_write (_ ("Encountered unprocessed marker %s\n") % self)
974 def ly_expression (self):
976 class RepeatMarker (Marker):
978 Marker.__init__ (self)
980 class EndingMarker (Marker):
983 # Convert the <barline> element to musicxml.BarLine (for non-standard barlines)
984 # and to RepeatMarker and EndingMarker objects for repeat and
985 # alternatives start/stops
986 def musicxml_barline_to_lily (barline):
987 # retval contains all possible markers in the order:
988 # 0..bw_ending, 1..bw_repeat, 2..barline, 3..fw_repeat, 4..fw_ending
990 bartype_element = barline.get_maybe_exist_named_child ("bar-style")
991 repeat_element = barline.get_maybe_exist_named_child ("repeat")
992 ending_element = barline.get_maybe_exist_named_child ("ending")
996 bartype = bartype_element.get_text ()
998 if repeat_element and hasattr (repeat_element, 'direction'):
999 repeat = RepeatMarker ()
1000 repeat.direction = {"forward": -1, "backward": 1}.get (repeat_element.direction, 0)
1002 if ( (repeat_element.direction == "forward" and bartype == "heavy-light") or
1003 (repeat_element.direction == "backward" and bartype == "light-heavy") ):
1005 if hasattr (repeat_element, 'times'):
1007 repeat.times = int (repeat_element.times)
1010 repeat.event = barline
1011 if repeat.direction == -1:
1016 if ending_element and hasattr (ending_element, 'type'):
1017 ending = EndingMarker ()
1018 ending.direction = {"start": -1, "stop": 1, "discontinue": 1}.get (ending_element.type, 0)
1019 ending.event = barline
1020 if ending.direction == -1:
1026 b = musicexp.BarLine ()
1030 return retval.values ()
1032 spanner_event_dict = {
1033 'beam' : musicexp.BeamEvent,
1034 'dashes' : musicexp.TextSpannerEvent,
1035 'bracket' : musicexp.BracketSpannerEvent,
1036 'glissando' : musicexp.GlissandoEvent,
1037 'octave-shift' : musicexp.OctaveShiftEvent,
1038 'pedal' : musicexp.PedalEvent,
1039 'slide' : musicexp.GlissandoEvent,
1040 'slur' : musicexp.SlurEvent,
1041 'wavy-line' : musicexp.TrillSpanEvent,
1042 'wedge' : musicexp.HairpinEvent
1044 spanner_type_dict = {
1058 def musicxml_spanner_to_lily_event (mxl_event):
1061 name = mxl_event.get_name()
1062 func = spanner_event_dict.get (name)
1066 error_message (_ ('unknown span event %s') % mxl_event)
1069 type = mxl_event.get_type ()
1070 span_direction = spanner_type_dict.get (type)
1071 # really check for None, because some types will be translated to 0, which
1072 # would otherwise also lead to the unknown span warning
1073 if span_direction != None:
1074 ev.span_direction = span_direction
1076 error_message (_ ('unknown span type %s for %s') % (type, name))
1078 ev.set_span_type (type)
1079 ev.line_type = getattr (mxl_event, 'line-type', 'solid')
1081 # assign the size, which is used for octave-shift, etc.
1082 ev.size = mxl_event.get_size ()
1086 def musicxml_direction_to_indicator (direction):
1087 return { "above": 1, "upright": 1, "up": 1, "below": -1, "downright": -1, "down": -1, "inverted": -1 }.get (direction, 0)
1089 def musicxml_fermata_to_lily_event (mxl_event):
1090 ev = musicexp.ArticulationEvent ()
1091 txt = mxl_event.get_text ()
1092 # The contents of the element defined the shape, possible are normal, angled and square
1093 ev.type = { "angled": "shortfermata", "square": "longfermata" }.get (txt, "fermata")
1094 if hasattr (mxl_event, 'type'):
1095 dir = musicxml_direction_to_indicator (mxl_event.type)
1096 if dir and options.convert_directions:
1097 ev.force_direction = dir
1100 def musicxml_arpeggiate_to_lily_event (mxl_event):
1101 ev = musicexp.ArpeggioEvent ()
1102 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
1105 def musicxml_nonarpeggiate_to_lily_event (mxl_event):
1106 ev = musicexp.ArpeggioEvent ()
1107 ev.non_arpeggiate = True
1108 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
1111 def musicxml_tremolo_to_lily_event (mxl_event):
1112 ev = musicexp.TremoloEvent ()
1113 txt = mxl_event.get_text ()
1120 def musicxml_falloff_to_lily_event (mxl_event):
1121 ev = musicexp.BendEvent ()
1125 def musicxml_doit_to_lily_event (mxl_event):
1126 ev = musicexp.BendEvent ()
1130 def musicxml_bend_to_lily_event (mxl_event):
1131 ev = musicexp.BendEvent ()
1132 ev.alter = mxl_event.bend_alter ()
1135 def musicxml_caesura_to_lily_event (mxl_event):
1136 ev = musicexp.MarkupEvent ()
1137 # FIXME: default to straight or curved caesura?
1138 ev.contents = "\\musicglyph #\"scripts.caesura.straight\""
1139 ev.force_direction = 1
1142 def musicxml_fingering_event (mxl_event):
1143 ev = musicexp.ShortArticulationEvent ()
1144 ev.type = mxl_event.get_text ()
1147 def musicxml_snappizzicato_event (mxl_event):
1148 needed_additional_definitions.append ("snappizzicato")
1149 ev = musicexp.MarkupEvent ()
1150 ev.contents = "\\snappizzicato"
1153 def musicxml_string_event (mxl_event):
1154 ev = musicexp.NoDirectionArticulationEvent ()
1155 ev.type = mxl_event.get_text ()
1158 def musicxml_accidental_mark (mxl_event):
1159 ev = musicexp.MarkupEvent ()
1160 contents = { "sharp": "\\sharp",
1161 "natural": "\\natural",
1163 "double-sharp": "\\doublesharp",
1164 "sharp-sharp": "\\sharp\\sharp",
1165 "flat-flat": "\\flat\\flat",
1166 "flat-flat": "\\doubleflat",
1167 "natural-sharp": "\\natural\\sharp",
1168 "natural-flat": "\\natural\\flat",
1169 "quarter-flat": "\\semiflat",
1170 "quarter-sharp": "\\semisharp",
1171 "three-quarters-flat": "\\sesquiflat",
1172 "three-quarters-sharp": "\\sesquisharp",
1173 }.get (mxl_event.get_text ())
1175 ev.contents = contents
1180 # translate articulations, ornaments and other notations into ArticulationEvents
1182 # -) string (ArticulationEvent with that name)
1183 # -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
1184 # -) (class, name) (like string, only that a different class than ArticulationEvent is used)
1185 # TODO: Some translations are missing!
1186 articulations_dict = {
1187 "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
1188 "accidental-mark": musicxml_accidental_mark,
1189 "bend": musicxml_bend_to_lily_event,
1190 "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
1191 "caesura": musicxml_caesura_to_lily_event,
1192 #"delayed-turn": "?",
1193 "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
1194 "doit": musicxml_doit_to_lily_event,
1195 #"double-tongue": "?",
1196 "down-bow": "downbow",
1197 "falloff": musicxml_falloff_to_lily_event,
1198 "fingering": musicxml_fingering_event,
1199 #"fingernails": "?",
1202 "harmonic": "flageolet",
1204 "inverted-mordent": "prall",
1205 "inverted-turn": "reverseturn",
1206 "mordent": "mordent",
1207 "open-string": "open",
1214 "snap-pizzicato": musicxml_snappizzicato_event,
1216 "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
1217 "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
1218 "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
1220 "string": musicxml_string_event,
1221 "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
1223 "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
1224 "thumb-position": "thumb",
1227 "tremolo": musicxml_tremolo_to_lily_event,
1228 "trill-mark": "trill",
1229 #"triple-tongue": "?",
1234 articulation_spanners = [ "wavy-line" ]
1236 def musicxml_articulation_to_lily_event (mxl_event):
1237 # wavy-line elements are treated as trill spanners, not as articulation ornaments
1238 if mxl_event.get_name () in articulation_spanners:
1239 return musicxml_spanner_to_lily_event (mxl_event)
1241 tmp_tp = articulations_dict.get (mxl_event.get_name ())
1245 if isinstance (tmp_tp, str):
1246 ev = musicexp.ArticulationEvent ()
1248 elif isinstance (tmp_tp, tuple):
1252 ev = tmp_tp (mxl_event)
1254 # Some articulations use the type attribute, other the placement...
1256 if hasattr (mxl_event, 'type') and options.convert_directions:
1257 dir = musicxml_direction_to_indicator (mxl_event.type)
1258 if hasattr (mxl_event, 'placement') and options.convert_directions:
1259 dir = musicxml_direction_to_indicator (mxl_event.placement)
1261 ev.force_direction = dir
1266 def musicxml_dynamics_to_lily_event (dynentry):
1267 dynamics_available = (
1268 "ppppp", "pppp", "ppp", "pp", "p", "mp", "mf",
1269 "f", "ff", "fff", "ffff", "fp", "sf", "sff", "sp", "spp", "sfz", "rfz" )
1270 dynamicsname = dynentry.get_name ()
1271 if dynamicsname == "other-dynamics":
1272 dynamicsname = dynentry.get_text ()
1273 if not dynamicsname or dynamicsname=="#text":
1276 if not dynamicsname in dynamics_available:
1277 # Get rid of - in tag names (illegal in ly tags!)
1278 dynamicstext = dynamicsname
1279 dynamicsname = string.replace (dynamicsname, "-", "")
1280 additional_definitions[dynamicsname] = dynamicsname + \
1281 " = #(make-dynamic-script \"" + dynamicstext + "\")"
1282 needed_additional_definitions.append (dynamicsname)
1283 event = musicexp.DynamicsEvent ()
1284 event.type = dynamicsname
1287 # Convert single-color two-byte strings to numbers 0.0 - 1.0
1288 def hexcolorval_to_nr (hex_val):
1290 v = int (hex_val, 16)
1297 def hex_to_color (hex_val):
1298 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)
1300 return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
1304 def musicxml_words_to_lily_event (words):
1305 event = musicexp.TextEvent ()
1306 text = words.get_text ()
1307 text = re.sub ('^ *\n? *', '', text)
1308 text = re.sub (' *\n? *$', '', text)
1311 if hasattr (words, 'default-y') and options.convert_directions:
1312 offset = getattr (words, 'default-y')
1314 off = string.atoi (offset)
1316 event.force_direction = 1
1318 event.force_direction = -1
1320 event.force_direction = 0
1322 if hasattr (words, 'font-weight'):
1323 font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
1325 event.markup += font_weight
1327 if hasattr (words, 'font-size'):
1328 size = getattr (words, 'font-size')
1330 "xx-small": '\\teeny',
1331 "x-small": '\\tiny',
1335 "x-large": '\\huge',
1336 "xx-large": '\\larger\\huge'
1339 event.markup += font_size
1341 if hasattr (words, 'color'):
1342 color = getattr (words, 'color')
1343 rgb = hex_to_color (color)
1345 event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
1347 if hasattr (words, 'font-style'):
1348 font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
1350 event.markup += font_style
1352 # TODO: How should I best convert the font-family attribute?
1354 # TODO: How can I represent the underline, overline and line-through
1355 # attributes in Lilypond? Values of these attributes indicate
1356 # the number of lines
1361 # convert accordion-registration to lilypond.
1362 # Since lilypond does not have any built-in commands, we need to create
1363 # the markup commands manually and define our own variables.
1364 # Idea was taken from: http://lsr.dsi.unimi.it/LSR/Item?id=194
1365 def musicxml_accordion_to_markup (mxl_event):
1366 commandname = "accReg"
1369 high = mxl_event.get_maybe_exist_named_child ('accordion-high')
1372 command += """\\combine
1373 \\raise #2.5 \\musicglyph #\"accordion.accDot\"
1375 middle = mxl_event.get_maybe_exist_named_child ('accordion-middle')
1377 # By default, use one dot (when no or invalid content is given). The
1378 # MusicXML spec is quiet about this case...
1381 txt = string.atoi (middle.get_text ())
1385 commandname += "MMM"
1386 command += """\\combine
1387 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1389 \\raise #1.5 \\translate #(cons 1 0) \\musicglyph #\"accordion.accDot\"
1391 \\raise #1.5 \\translate #(cons -1 0) \\musicglyph #\"accordion.accDot\"
1395 command += """\\combine
1396 \\raise #1.5 \\translate #(cons 0.5 0) \\musicglyph #\"accordion.accDot\"
1398 \\raise #1.5 \\translate #(cons -0.5 0) \\musicglyph #\"accordion.accDot\"
1402 command += """\\combine
1403 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1405 low = mxl_event.get_maybe_exist_named_child ('accordion-low')
1408 command += """\\combine
1409 \\raise #0.5 \musicglyph #\"accordion.accDot\"
1412 command += "\musicglyph #\"accordion.accDiscant\""
1413 command = "\\markup { \\normalsize %s }" % command
1414 # Define the newly built command \accReg[H][MMM][L]
1415 additional_definitions[commandname] = "%s = %s" % (commandname, command)
1416 needed_additional_definitions.append (commandname)
1417 return "\\%s" % commandname
1419 def musicxml_accordion_to_ly (mxl_event):
1420 txt = musicxml_accordion_to_markup (mxl_event)
1422 ev = musicexp.MarkEvent (txt)
1427 def musicxml_rehearsal_to_ly_mark (mxl_event):
1428 text = mxl_event.get_text ()
1431 # default is boxed rehearsal marks!
1433 if hasattr (mxl_event, 'enclosure'):
1434 encl = {"none": None, "square": "box", "circle": "circle" }.get (mxl_event.enclosure, None)
1436 text = "\\%s { %s }" % (encl, text)
1437 ev = musicexp.MarkEvent ("\\markup { %s }" % text)
1440 def musicxml_harp_pedals_to_ly (mxl_event):
1442 result = "\\harp-pedal #\""
1443 for t in mxl_event.get_named_children ('pedal-tuning'):
1444 alter = t.get_named_child ('pedal-alter')
1446 val = int (alter.get_text ().strip ())
1447 result += {1: "v", 0: "-", -1: "^"}.get (val, "")
1451 ev = musicexp.MarkupEvent ()
1452 ev.contents = result + "\""
1455 def musicxml_eyeglasses_to_ly (mxl_event):
1456 needed_additional_definitions.append ("eyeglasses")
1457 return musicexp.MarkEvent ("\\eyeglasses")
1459 def next_non_hash_index (lst, pos):
1461 while pos < len (lst) and isinstance (lst[pos], musicxml.Hash_text):
1465 def musicxml_metronome_to_ly (mxl_event):
1466 children = mxl_event.get_all_children ()
1471 index = next_non_hash_index (children, index)
1472 if isinstance (children[index], musicxml.BeatUnit):
1473 # first form of metronome-mark, using unit and beats/min or other unit
1474 ev = musicexp.TempoMark ()
1475 if hasattr (mxl_event, 'parentheses'):
1476 ev.set_parentheses (mxl_event.parentheses == "yes")
1478 d = musicexp.Duration ()
1479 d.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1480 index = next_non_hash_index (children, index)
1481 if isinstance (children[index], musicxml.BeatUnitDot):
1483 index = next_non_hash_index (children, index)
1484 ev.set_base_duration (d)
1485 if isinstance (children[index], musicxml.BeatUnit):
1486 # Form "note = newnote"
1487 newd = musicexp.Duration ()
1488 newd.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1489 index = next_non_hash_index (children, index)
1490 if isinstance (children[index], musicxml.BeatUnitDot):
1492 index = next_non_hash_index (children, index)
1493 ev.set_new_duration (newd)
1494 elif isinstance (children[index], musicxml.PerMinute):
1497 beats = int (children[index].get_text ())
1498 ev.set_beats_per_minute (beats)
1502 error_message (_ ("Unknown metronome mark, ignoring"))
1506 #TODO: Implement the other (more complex) way for tempo marks!
1507 error_message (_ ("Metronome marks with complex relations (<metronome-note> in MusicXML) are not yet implemented."))
1510 # translate directions into Events, possible values:
1511 # -) string (MarkEvent with that command)
1512 # -) function (function(mxl_event) needs to return a full Event-derived object
1513 # -) (class, name) (like string, only that a different class than MarkEvent is used)
1515 'accordion-registration' : musicxml_accordion_to_ly,
1516 'coda' : (musicexp.MusicGlyphMarkEvent, "coda"),
1519 'eyeglasses': musicxml_eyeglasses_to_ly,
1520 'harp-pedals' : musicxml_harp_pedals_to_ly,
1522 'metronome' : musicxml_metronome_to_ly,
1523 'rehearsal' : musicxml_rehearsal_to_ly_mark,
1524 # 'scordatura' : ???
1525 'segno' : (musicexp.MusicGlyphMarkEvent, "segno"),
1526 'words' : musicxml_words_to_lily_event,
1528 directions_spanners = [ 'octave-shift', 'pedal', 'wedge', 'dashes', 'bracket' ]
1530 def musicxml_direction_to_lily (n):
1531 # TODO: Handle the <staff> element!
1533 # placement applies to all children!
1535 if hasattr (n, 'placement') and options.convert_directions:
1536 dir = musicxml_direction_to_indicator (n.placement)
1537 dirtype_children = []
1538 # TODO: The direction-type is used for grouping (e.g. dynamics with text),
1539 # so we can't simply flatten them out!
1540 for dt in n.get_typed_children (musicxml.DirType):
1541 dirtype_children += dt.get_all_children ()
1543 for entry in dirtype_children:
1544 # backets, dashes, octave shifts. pedal marks, hairpins etc. are spanners:
1545 if entry.get_name() in directions_spanners:
1546 event = musicxml_spanner_to_lily_event (entry)
1551 # now treat all the "simple" ones, that can be translated using the dict
1553 tmp_tp = directions_dict.get (entry.get_name (), None)
1554 if isinstance (tmp_tp, str): # string means MarkEvent
1555 ev = musicexp.MarkEvent (tmp_tp)
1556 elif isinstance (tmp_tp, tuple): # tuple means (EventClass, "text")
1557 ev = tmp_tp[0] (tmp_tp[1])
1561 # TODO: set the correct direction! Unfortunately, \mark in ly does
1562 # not seem to support directions!
1566 if entry.get_name () == "dynamics":
1567 for dynentry in entry.get_all_children ():
1568 ev = musicxml_dynamics_to_lily_event (dynentry)
1574 def musicxml_frame_to_lily_event (frame):
1575 ev = musicexp.FretEvent ()
1576 ev.strings = frame.get_strings ()
1577 ev.frets = frame.get_frets ()
1578 #offset = frame.get_first_fret () - 1
1580 for fn in frame.get_named_children ('frame-note'):
1581 fret = fn.get_fret ()
1584 el = [ fn.get_string (), fret ]
1585 fingering = fn.get_fingering ()
1587 el.append (fingering)
1588 ev.elements.append (el)
1591 barre[0] = el[0] # start string
1592 barre[2] = el[1] # fret
1594 barre[1] = el[0] # end string
1599 def musicxml_harmony_to_lily (n):
1601 for f in n.get_named_children ('frame'):
1602 ev = musicxml_frame_to_lily_event (f)
1608 notehead_styles_dict = {
1610 'triangle': '\'triangle',
1611 'diamond': '\'diamond',
1612 'square': '\'la', # TODO: Proper squared note head
1613 'cross': None, # TODO: + shaped note head
1615 'circle-x': '\'xcircle',
1616 'inverted triangle': None, # TODO: Implement
1617 'arrow down': None, # TODO: Implement
1618 'arrow up': None, # TODO: Implement
1619 'slashed': None, # TODO: Implement
1620 'back slashed': None, # TODO: Implement
1622 'cluster': None, # TODO: Implement
1633 def musicxml_notehead_to_lily (nh):
1637 style = notehead_styles_dict.get (nh.get_text ().strip (), None)
1638 style_elm = musicexp.NotestyleEvent ()
1640 style_elm.style = style
1641 if hasattr (nh, 'filled'):
1642 style_elm.filled = (getattr (nh, 'filled') == "yes")
1643 if style_elm.style or (style_elm.filled != None):
1644 styles.append (style_elm)
1647 if hasattr (nh, 'parentheses') and (nh.parentheses == "yes"):
1648 styles.append (musicexp.ParenthesizeEvent ())
1652 def musicxml_chordpitch_to_lily (mxl_cpitch):
1653 r = musicexp.ChordPitch ()
1654 r.alteration = mxl_cpitch.get_alteration ()
1655 r.step = musicxml_step_to_lily (mxl_cpitch.get_step ())
1661 'augmented': 'aug5',
1662 'diminished': 'dim5',
1665 'dominant-seventh': '7',
1666 'major-seventh': 'maj7',
1667 'minor-seventh': 'm7',
1668 'diminished-seventh': 'dim7',
1669 'augmented-seventh': 'aug7',
1670 'half-diminished': 'dim5m7',
1671 'major-minor': 'maj7m5',
1674 'minor-sixth': 'm6',
1676 'dominant-ninth': '9',
1677 'major-ninth': 'maj9',
1678 'minor-ninth': 'm9',
1679 # 11ths (usually as the basis for alteration):
1680 'dominant-11th': '11',
1681 'major-11th': 'maj11',
1682 'minor-11th': 'm11',
1683 # 13ths (usually as the basis for alteration):
1684 'dominant-13th': '13.11',
1685 'major-13th': 'maj13.11',
1686 'minor-13th': 'm13',
1688 'suspended-second': 'sus2',
1689 'suspended-fourth': 'sus4',
1690 # Functional sixths:
1692 #'Neapolitan': '???',
1697 #'pedal': '???',(pedal-point bass)
1704 def musicxml_chordkind_to_lily (kind):
1705 res = chordkind_dict.get (kind, None)
1706 # Check for None, since a major chord is converted to ''
1708 error_message (_ ("Unable to convert chord type %s to lilypond.") % kind)
1711 def musicxml_harmony_to_lily_chordname (n):
1713 root = n.get_maybe_exist_named_child ('root')
1715 ev = musicexp.ChordNameEvent ()
1716 ev.root = musicxml_chordpitch_to_lily (root)
1717 kind = n.get_maybe_exist_named_child ('kind')
1719 ev.kind = musicxml_chordkind_to_lily (kind.get_text ())
1722 bass = n.get_maybe_exist_named_child ('bass')
1724 ev.bass = musicxml_chordpitch_to_lily (bass)
1725 inversion = n.get_maybe_exist_named_child ('inversion')
1727 # TODO: Lilypond does not support inversions, does it?
1729 # Mail from Carl Sorensen on lilypond-devel, June 11, 2008:
1730 # 4. LilyPond supports the first inversion in the form of added
1731 # bass notes. So the first inversion of C major would be c:/g.
1732 # To get the second inversion of C major, you would need to do
1733 # e:6-3-^5 or e:m6-^5. However, both of these techniques
1734 # require you to know the chord and calculate either the fifth
1735 # pitch (for the first inversion) or the third pitch (for the
1736 # second inversion) so they may not be helpful for musicxml2ly.
1737 inversion_count = string.atoi (inversion.get_text ())
1738 if inversion_count == 1:
1739 # TODO: Calculate the bass note for the inversion...
1742 for deg in n.get_named_children ('degree'):
1743 d = musicexp.ChordModification ()
1744 d.type = deg.get_type ()
1745 d.step = deg.get_value ()
1746 d.alteration = deg.get_alter ()
1747 ev.add_modification (d)
1748 #TODO: convert the user-symbols attribute:
1749 #major: a triangle, like Unicode 25B3
1750 #minor: -, like Unicode 002D
1751 #augmented: +, like Unicode 002B
1752 #diminished: (degree), like Unicode 00B0
1753 #half-diminished: (o with slash), like Unicode 00F8
1759 def musicxml_figured_bass_note_to_lily (n):
1760 res = musicexp.FiguredBassNote ()
1761 suffix_dict = { 'sharp' : "+",
1764 'double-sharp' : "++",
1766 'sharp-sharp' : "++",
1768 prefix = n.get_maybe_exist_named_child ('prefix')
1770 res.set_prefix (suffix_dict.get (prefix.get_text (), ""))
1771 fnumber = n.get_maybe_exist_named_child ('figure-number')
1773 res.set_number (fnumber.get_text ())
1774 suffix = n.get_maybe_exist_named_child ('suffix')
1776 res.set_suffix (suffix_dict.get (suffix.get_text (), ""))
1777 if n.get_maybe_exist_named_child ('extend'):
1778 # TODO: Implement extender lines (unfortunately, in lilypond you have
1779 # to use \set useBassFigureExtenders = ##t, which turns them on
1780 # globally, while MusicXML has a property for each note...
1781 # I'm not sure there is a proper way to implement this cleanly
1788 def musicxml_figured_bass_to_lily (n):
1789 if not isinstance (n, musicxml.FiguredBass):
1791 res = musicexp.FiguredBassEvent ()
1792 for i in n.get_named_children ('figure'):
1793 note = musicxml_figured_bass_note_to_lily (i)
1796 dur = n.get_maybe_exist_named_child ('duration')
1798 # apply the duration to res
1799 length = Rational(int(dur.get_text()), n._divisions)*Rational(1,4)
1800 res.set_real_duration (length)
1801 duration = rational_to_lily_duration (length)
1803 res.set_duration (duration)
1804 if hasattr (n, 'parentheses') and n.parentheses == "yes":
1805 res.set_parentheses (True)
1808 instrument_drumtype_dict = {
1809 'Acoustic Snare Drum': 'acousticsnare',
1810 'Side Stick': 'sidestick',
1811 'Open Triangle': 'opentriangle',
1812 'Mute Triangle': 'mutetriangle',
1813 'Tambourine': 'tambourine',
1814 'Bass Drum': 'bassdrum',
1817 def musicxml_note_to_lily_main_event (n):
1822 mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1824 pitch = musicxml_pitch_to_lily (mxl_pitch)
1825 event = musicexp.NoteEvent ()
1828 acc = n.get_maybe_exist_named_child ('accidental')
1830 # let's not force accs everywhere.
1831 event.cautionary = acc.editorial
1833 elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1834 # Unpitched elements have display-step and can also have
1836 unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1837 event = musicexp.NoteEvent ()
1838 event.pitch = musicxml_unpitched_to_lily (unpitched)
1840 elif n.get_maybe_exist_typed_child (musicxml.Rest):
1841 # rests can have display-octave and display-step, which are
1842 # treated like an ordinary note pitch
1843 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1844 event = musicexp.RestEvent ()
1845 if options.convert_rest_positions:
1846 pitch = musicxml_restdisplay_to_lily (rest)
1849 elif n.instrument_name:
1850 event = musicexp.NoteEvent ()
1851 drum_type = instrument_drumtype_dict.get (n.instrument_name)
1853 event.drum_type = drum_type
1855 n.message (_ ("drum %s type unknown, please add to instrument_drumtype_dict") % n.instrument_name)
1856 event.drum_type = 'acousticsnare'
1859 n.message (_ ("cannot find suitable event"))
1862 event.duration = musicxml_duration_to_lily (n)
1864 noteheads = n.get_named_children ('notehead')
1865 for nh in noteheads:
1866 styles = musicxml_notehead_to_lily (nh)
1868 event.add_associated_event (s)
1872 def musicxml_lyrics_to_text (lyrics):
1873 # TODO: Implement text styles for lyrics syllables
1877 for e in lyrics.get_all_children ():
1878 if isinstance (e, musicxml.Syllabic):
1879 continued = e.continued ()
1880 elif isinstance (e, musicxml.Text):
1881 # We need to convert soft hyphens to -, otherwise the ascii codec as well
1882 # as lilypond will barf on that character
1883 text += string.replace( e.get_text(), u'\xad', '-' )
1884 elif isinstance (e, musicxml.Elision):
1889 elif isinstance (e, musicxml.Extend):
1894 if text == "-" and continued:
1896 elif text == "_" and extended:
1898 elif continued and text:
1899 return musicxml.escape_ly_output_string (text) + " --"
1902 elif extended and text:
1903 return musicxml.escape_ly_output_string (text) + " __"
1907 return musicxml.escape_ly_output_string (text)
1913 def __init__ (self, here, dest):
1917 class LilyPondVoiceBuilder:
1918 def __init__ (self):
1920 self.pending_dynamics = []
1921 self.end_moment = Rational (0)
1922 self.begin_moment = Rational (0)
1923 self.pending_multibar = Rational (0)
1924 self.ignore_skips = False
1925 self.has_relevant_elements = False
1926 self.measure_length = Rational (4, 4)
1928 def _insert_multibar (self):
1929 layout_information.set_context_item ('Score', 'skipBars = ##t')
1930 r = musicexp.MultiMeasureRest ()
1931 lenfrac = self.measure_length
1932 r.duration = rational_to_lily_duration (lenfrac)
1933 r.duration.factor *= self.pending_multibar / lenfrac
1934 self.elements.append (r)
1935 self.begin_moment = self.end_moment
1936 self.end_moment = self.begin_moment + self.pending_multibar
1937 self.pending_multibar = Rational (0)
1939 def set_measure_length (self, mlen):
1940 if (mlen != self.measure_length) and self.pending_multibar:
1941 self._insert_multibar ()
1942 self.measure_length = mlen
1944 def add_multibar_rest (self, duration):
1945 self.pending_multibar += duration
1947 def set_duration (self, duration):
1948 self.end_moment = self.begin_moment + duration
1949 def current_duration (self):
1950 return self.end_moment - self.begin_moment
1952 def add_music (self, music, duration):
1953 assert isinstance (music, musicexp.Music)
1954 if self.pending_multibar > Rational (0):
1955 self._insert_multibar ()
1957 self.has_relevant_elements = True
1958 self.elements.append (music)
1959 self.begin_moment = self.end_moment
1960 self.set_duration (duration)
1962 # Insert all pending dynamics right after the note/rest:
1963 if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1964 for d in self.pending_dynamics:
1966 self.pending_dynamics = []
1968 # Insert some music command that does not affect the position in the measure
1969 def add_command (self, command):
1970 assert isinstance (command, musicexp.Music)
1971 if self.pending_multibar > Rational (0):
1972 self._insert_multibar ()
1973 self.has_relevant_elements = True
1974 self.elements.append (command)
1975 def add_barline (self, barline):
1976 # TODO: Implement merging of default barline and custom bar line
1977 self.add_music (barline, Rational (0))
1978 def add_partial (self, command):
1979 self.ignore_skips = True
1980 self.add_command (command)
1982 def add_dynamics (self, dynamic):
1983 # store the dynamic item(s) until we encounter the next note/rest:
1984 self.pending_dynamics.append (dynamic)
1986 def add_bar_check (self, number):
1987 # re/store has_relevant_elements, so that a barline alone does not
1988 # trigger output for figured bass, chord names
1989 has_relevant = self.has_relevant_elements
1990 b = musicexp.BarLine ()
1991 b.bar_number = number
1992 self.add_barline (b)
1993 self.has_relevant_elements = has_relevant
1995 def jumpto (self, moment):
1996 current_end = self.end_moment + self.pending_multibar
1997 diff = moment - current_end
1999 if diff < Rational (0):
2000 error_message (_ ('Negative skip %s (from position %s to %s)') %
2001 (diff, current_end, moment))
2004 if diff > Rational (0) and not (self.ignore_skips and moment == 0):
2005 skip = musicexp.SkipEvent()
2007 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)
2009 # TODO: Use the time signature for skips, too. Problem: The skip
2010 # might not start at a measure boundary!
2011 if duration_log > 0: # denominator is a power of 2...
2012 if diff.numerator () == 3:
2016 duration_factor = Rational (diff.numerator ())
2018 # for skips of a whole or more, simply use s1*factor
2020 duration_factor = diff
2021 skip.duration.duration_log = duration_log
2022 skip.duration.factor = duration_factor
2023 skip.duration.dots = duration_dots
2025 evc = musicexp.ChordEvent ()
2026 evc.elements.append (skip)
2027 self.add_music (evc, diff)
2029 if diff > Rational (0) and moment == 0:
2030 self.ignore_skips = False
2032 def last_event_chord (self, starting_at):
2036 # if the position matches, find the last ChordEvent, do not cross a bar line!
2037 at = len( self.elements ) - 1
2039 not isinstance (self.elements[at], musicexp.ChordEvent) and
2040 not isinstance (self.elements[at], musicexp.BarLine)):
2045 and isinstance (self.elements[at], musicexp.ChordEvent)
2046 and self.begin_moment == starting_at):
2047 value = self.elements[at]
2049 self.jumpto (starting_at)
2053 def correct_negative_skip (self, goto):
2054 self.end_moment = goto
2055 self.begin_moment = goto
2056 evc = musicexp.ChordEvent ()
2057 self.elements.append (evc)
2061 def __init__ (self):
2062 self.voicename = None
2063 self.voicedata = None
2064 self.ly_voice = None
2065 self.figured_bass = None
2066 self.chordnames = None
2067 self.lyrics_dict = {}
2068 self.lyrics_order = []
2070 def musicxml_step_to_lily (step):
2072 return (ord (step) - ord ('A') + 7 - 2) % 7
2076 def measure_length_from_attributes (attr, current_measure_length):
2077 len = attr.get_measure_length ()
2079 len = current_measure_length
2082 def musicxml_voice_to_lily_voice (voice):
2086 return_value = VoiceData ()
2087 return_value.voicedata = voice
2089 # First pitch needed for relative mode (if selected in command-line options)
2092 # Needed for melismata detection (ignore lyrics on those notes!):
2097 ignore_lyrics = False
2099 current_staff = None
2101 pending_figured_bass = []
2102 pending_chordnames = []
2104 # Make sure that the keys in the dict don't get reordered, since
2105 # we need the correct ordering of the lyrics stanzas! By default,
2106 # a dict will reorder its keys
2107 return_value.lyrics_order = voice.get_lyrics_numbers ()
2108 for k in return_value.lyrics_order:
2111 voice_builder = LilyPondVoiceBuilder ()
2112 figured_bass_builder = LilyPondVoiceBuilder ()
2113 chordnames_builder = LilyPondVoiceBuilder ()
2114 current_measure_length = Rational (4, 4)
2115 voice_builder.set_measure_length (current_measure_length)
2117 for n in voice._elements:
2118 if n.get_name () == 'forward':
2120 staff = n.get_maybe_exist_named_child ('staff')
2122 staff = staff.get_text ()
2123 if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
2124 voice_builder.add_command (musicexp.StaffChange (staff))
2125 current_staff = staff
2127 if isinstance (n, musicxml.Partial) and n.partial > 0:
2128 a = musicxml_partial_to_lily (n.partial)
2130 voice_builder.add_partial (a)
2133 is_chord = n.get_maybe_exist_named_child ('chord')
2134 is_after_grace = (isinstance (n, musicxml.Note) and n.is_after_grace ());
2135 if not is_chord and not is_after_grace:
2137 voice_builder.jumpto (n._when)
2138 except NegativeSkip, neg:
2139 voice_builder.correct_negative_skip (n._when)
2140 n.message (_ ("Negative skip found: from %s to %s, difference is %s") % (neg.here, neg.dest, neg.dest - neg.here))
2142 if isinstance (n, musicxml.Barline):
2143 barlines = musicxml_barline_to_lily (n)
2145 if isinstance (a, musicexp.BarLine):
2146 voice_builder.add_barline (a)
2147 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
2148 voice_builder.add_command (a)
2151 # Continue any multimeasure-rests before trying to add bar checks!
2152 # Don't handle new MM rests yet, because for them we want bar checks!
2153 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
2154 if (rest and rest.is_whole_measure ()
2155 and voice_builder.pending_multibar > Rational (0)):
2156 voice_builder.add_multibar_rest (n._duration)
2160 # print a bar check at the beginning of each measure!
2161 if n.is_first () and n._measure_position == Rational (0) and n != voice._elements[0]:
2163 num = int (n.get_parent ().number)
2167 voice_builder.add_bar_check (num)
2168 figured_bass_builder.add_bar_check (num)
2169 chordnames_builder.add_bar_check (num)
2171 # Start any new multimeasure rests
2172 if (rest and rest.is_whole_measure ()):
2173 voice_builder.add_multibar_rest (n._duration)
2177 if isinstance (n, musicxml.Direction):
2178 for a in musicxml_direction_to_lily (n):
2179 if a.wait_for_note ():
2180 voice_builder.add_dynamics (a)
2182 voice_builder.add_command (a)
2185 if isinstance (n, musicxml.Harmony):
2186 for a in musicxml_harmony_to_lily (n):
2187 if a.wait_for_note ():
2188 voice_builder.add_dynamics (a)
2190 voice_builder.add_command (a)
2191 for a in musicxml_harmony_to_lily_chordname (n):
2192 pending_chordnames.append (a)
2195 if isinstance (n, musicxml.FiguredBass):
2196 a = musicxml_figured_bass_to_lily (n)
2198 pending_figured_bass.append (a)
2201 if isinstance (n, musicxml.Attributes):
2202 for a in musicxml_attributes_to_lily (n):
2203 voice_builder.add_command (a)
2204 measure_length = measure_length_from_attributes (n, current_measure_length)
2205 if current_measure_length != measure_length:
2206 current_measure_length = measure_length
2207 voice_builder.set_measure_length (current_measure_length)
2210 if not n.__class__.__name__ == 'Note':
2211 n.message (_ ('unexpected %s; expected %s or %s or %s') % (n, 'Note', 'Attributes', 'Barline'))
2214 main_event = musicxml_note_to_lily_main_event (n)
2215 if main_event and not first_pitch:
2216 first_pitch = main_event.pitch
2217 # ignore lyrics for notes inside a slur, tie, chord or beam
2218 ignore_lyrics = inside_slur or is_tied or is_chord or is_beamed
2220 if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
2221 modes_found['drummode'] = True
2223 ev_chord = voice_builder.last_event_chord (n._when)
2225 ev_chord = musicexp.ChordEvent()
2226 voice_builder.add_music (ev_chord, n._duration)
2229 grace = n.get_maybe_exist_typed_child (musicxml.Grace)
2231 is_after_grace = ev_chord.has_elements () or n.is_after_grace ();
2232 is_chord = n.get_maybe_exist_typed_child (musicxml.Chord)
2236 # after-graces and other graces use different lists; Depending on
2237 # whether we have a chord or not, obtain either a new ChordEvent or
2238 # the previous one to create a chord
2240 if ev_chord.after_grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
2241 grace_chord = ev_chord.after_grace_elements.get_last_event_chord ()
2243 grace_chord = musicexp.ChordEvent ()
2244 ev_chord.append_after_grace (grace_chord)
2246 if ev_chord.grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
2247 grace_chord = ev_chord.grace_elements.get_last_event_chord ()
2249 grace_chord = musicexp.ChordEvent ()
2250 ev_chord.append_grace (grace_chord)
2252 if hasattr (grace, 'slash') and not is_after_grace:
2253 # TODO: use grace_type = "appoggiatura" for slurred grace notes
2254 if grace.slash == "yes":
2255 ev_chord.grace_type = "acciaccatura"
2256 # now that we have inserted the chord into the grace music, insert
2257 # everything into that chord instead of the ev_chord
2258 ev_chord = grace_chord
2259 ev_chord.append (main_event)
2260 ignore_lyrics = True
2262 ev_chord.append (main_event)
2263 # When a note/chord has grace notes (duration==0), the duration of the
2264 # event chord is not yet known, but the event chord was already added
2265 # with duration 0. The following correct this when we hit the real note!
2266 if voice_builder.current_duration () == 0 and n._duration > 0:
2267 voice_builder.set_duration (n._duration)
2269 # if we have a figured bass, set its voice builder to the correct position
2270 # and insert the pending figures
2271 if pending_figured_bass:
2273 figured_bass_builder.jumpto (n._when)
2274 except NegativeSkip, neg:
2276 for fb in pending_figured_bass:
2277 # if a duration is given, use that, otherwise the one of the note
2278 dur = fb.real_duration
2280 dur = ev_chord.get_length ()
2282 fb.duration = ev_chord.get_duration ()
2283 figured_bass_builder.add_music (fb, dur)
2284 pending_figured_bass = []
2286 if pending_chordnames:
2288 chordnames_builder.jumpto (n._when)
2289 except NegativeSkip, neg:
2291 for cn in pending_chordnames:
2292 # Assign the duration of the EventChord
2293 cn.duration = ev_chord.get_duration ()
2294 chordnames_builder.add_music (cn, ev_chord.get_length ())
2295 pending_chordnames = []
2297 notations_children = n.get_typed_children (musicxml.Notations)
2301 # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
2302 # +tied | +slur | +tuplet | glissando | slide |
2303 # ornaments | technical | articulations | dynamics |
2304 # +fermata | arpeggiate | non-arpeggiate |
2305 # accidental-mark | other-notation
2306 for notations in notations_children:
2307 for tuplet_event in notations.get_tuplets():
2308 time_mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
2309 tuplet_events.append ((ev_chord, tuplet_event, time_mod))
2311 # First, close all open slurs, only then start any new slur
2312 # TODO: Record the number of the open slur to dtermine the correct
2314 endslurs = [s for s in notations.get_named_children ('slur')
2315 if s.get_type () in ('stop')]
2316 if endslurs and not inside_slur:
2317 endslurs[0].message (_ ('Encountered closing slur, but no slur is open'))
2319 if len (endslurs) > 1:
2320 endslurs[0].message (_ ('Cannot have two simultaneous (closing) slurs'))
2321 # record the slur status for the next note in the loop
2323 lily_ev = musicxml_spanner_to_lily_event (endslurs[0])
2324 ev_chord.append (lily_ev)
2326 startslurs = [s for s in notations.get_named_children ('slur')
2327 if s.get_type () in ('start')]
2328 if startslurs and inside_slur:
2329 startslurs[0].message (_ ('Cannot have a slur inside another slur'))
2331 if len (startslurs) > 1:
2332 startslurs[0].message (_ ('Cannot have two simultaneous slurs'))
2333 # record the slur status for the next note in the loop
2335 lily_ev = musicxml_spanner_to_lily_event (startslurs[0])
2336 ev_chord.append (lily_ev)
2340 mxl_tie = notations.get_tie ()
2341 if mxl_tie and mxl_tie.type == 'start':
2342 ev_chord.append (musicexp.TieEvent ())
2347 fermatas = notations.get_named_children ('fermata')
2349 ev = musicxml_fermata_to_lily_event (a)
2351 ev_chord.append (ev)
2353 arpeggiate = notations.get_named_children ('arpeggiate')
2354 for a in arpeggiate:
2355 ev = musicxml_arpeggiate_to_lily_event (a)
2357 ev_chord.append (ev)
2359 arpeggiate = notations.get_named_children ('non-arpeggiate')
2360 for a in arpeggiate:
2361 ev = musicxml_nonarpeggiate_to_lily_event (a)
2363 ev_chord.append (ev)
2365 glissandos = notations.get_named_children ('glissando')
2366 glissandos += notations.get_named_children ('slide')
2367 for a in glissandos:
2368 ev = musicxml_spanner_to_lily_event (a)
2370 ev_chord.append (ev)
2372 # accidental-marks are direct children of <notation>!
2373 for a in notations.get_named_children ('accidental-mark'):
2374 ev = musicxml_articulation_to_lily_event (a)
2376 ev_chord.append (ev)
2378 # Articulations can contain the following child elements:
2379 # accent | strong-accent | staccato | tenuto |
2380 # detached-legato | staccatissimo | spiccato |
2381 # scoop | plop | doit | falloff | breath-mark |
2382 # caesura | stress | unstress
2383 # Technical can contain the following child elements:
2384 # up-bow | down-bow | harmonic | open-string |
2385 # thumb-position | fingering | pluck | double-tongue |
2386 # triple-tongue | stopped | snap-pizzicato | fret |
2387 # string | hammer-on | pull-off | bend | tap | heel |
2388 # toe | fingernails | other-technical
2389 # Ornaments can contain the following child elements:
2390 # trill-mark | turn | delayed-turn | inverted-turn |
2391 # shake | wavy-line | mordent | inverted-mordent |
2392 # schleifer | tremolo | other-ornament, accidental-mark
2393 ornaments = notations.get_named_children ('ornaments')
2394 ornaments += notations.get_named_children ('articulations')
2395 ornaments += notations.get_named_children ('technical')
2398 for ch in a.get_all_children ():
2399 ev = musicxml_articulation_to_lily_event (ch)
2401 ev_chord.append (ev)
2403 dynamics = notations.get_named_children ('dynamics')
2405 for ch in a.get_all_children ():
2406 ev = musicxml_dynamics_to_lily_event (ch)
2408 ev_chord.append (ev)
2411 mxl_beams = [b for b in n.get_named_children ('beam')
2412 if (b.get_type () in ('begin', 'end')
2413 and b.is_primary ())]
2414 if mxl_beams and not conversion_settings.ignore_beaming:
2415 beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
2417 ev_chord.append (beam_ev)
2418 if beam_ev.span_direction == -1: # beam and thus melisma starts here
2420 elif beam_ev.span_direction == 1: # beam and thus melisma ends here
2423 # Extract the lyrics
2424 if not rest and not ignore_lyrics:
2425 note_lyrics_processed = []
2426 note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
2427 for l in note_lyrics_elements:
2428 if l.get_number () < 0:
2429 for k in lyrics.keys ():
2430 lyrics[k].append (musicxml_lyrics_to_text (l))
2431 note_lyrics_processed.append (k)
2433 lyrics[l.number].append(musicxml_lyrics_to_text (l))
2434 note_lyrics_processed.append (l.number)
2435 for lnr in lyrics.keys ():
2436 if not lnr in note_lyrics_processed:
2437 lyrics[lnr].append ("\skip4")
2439 ## force trailing mm rests to be written out.
2440 voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
2442 ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
2443 ly_voice = group_repeats (ly_voice)
2445 seq_music = musicexp.SequentialMusic ()
2447 if 'drummode' in modes_found.keys ():
2448 ## \key <pitch> barfs in drummode.
2449 ly_voice = [e for e in ly_voice
2450 if not isinstance(e, musicexp.KeySignatureChange)]
2452 seq_music.elements = ly_voice
2453 for k in lyrics.keys ():
2454 return_value.lyrics_dict[k] = musicexp.Lyrics ()
2455 return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
2458 if len (modes_found) > 1:
2459 error_message (_ ('cannot simultaneously have more than one mode: %s') % modes_found.keys ())
2461 if options.relative:
2462 v = musicexp.RelativeMusic ()
2463 v.element = seq_music
2464 v.basepitch = first_pitch
2467 return_value.ly_voice = seq_music
2468 for mode in modes_found.keys ():
2469 v = musicexp.ModeChangingMusicWrapper()
2470 v.element = seq_music
2472 return_value.ly_voice = v
2474 # create \figuremode { figured bass elements }
2475 if figured_bass_builder.has_relevant_elements:
2476 fbass_music = musicexp.SequentialMusic ()
2477 fbass_music.elements = figured_bass_builder.elements
2478 v = musicexp.ModeChangingMusicWrapper()
2479 v.mode = 'figuremode'
2480 v.element = fbass_music
2481 return_value.figured_bass = v
2483 # create \chordmode { chords }
2484 if chordnames_builder.has_relevant_elements:
2485 cname_music = musicexp.SequentialMusic ()
2486 cname_music.elements = chordnames_builder.elements
2487 v = musicexp.ModeChangingMusicWrapper()
2488 v.mode = 'chordmode'
2489 v.element = cname_music
2490 return_value.chordnames = v
2494 def musicxml_id_to_lily (id):
2495 digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
2496 'Six', 'Seven', 'Eight', 'Nine', 'Ten']
2498 for digit in digits:
2499 d = digits.index (digit)
2500 id = re.sub ('%d' % d, digit, id)
2502 id = re.sub ('[^a-zA-Z]', 'X', id)
2505 def musicxml_pitch_to_lily (mxl_pitch):
2506 p = musicexp.Pitch ()
2507 p.alteration = mxl_pitch.get_alteration ()
2508 p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
2509 p.octave = mxl_pitch.get_octave () - 4
2512 def musicxml_unpitched_to_lily (mxl_unpitched):
2514 step = mxl_unpitched.get_step ()
2516 p = musicexp.Pitch ()
2517 p.step = musicxml_step_to_lily (step)
2518 octave = mxl_unpitched.get_octave ()
2520 p.octave = octave - 4
2523 def musicxml_restdisplay_to_lily (mxl_rest):
2525 step = mxl_rest.get_step ()
2527 p = musicexp.Pitch ()
2528 p.step = musicxml_step_to_lily (step)
2529 octave = mxl_rest.get_octave ()
2531 p.octave = octave - 4
2534 def voices_in_part (part):
2535 """Return a Name -> Voice dictionary for PART"""
2537 part.extract_voices ()
2538 voices = part.get_voices ()
2539 part_info = part.get_staff_attributes ()
2541 return (voices, part_info)
2543 def voices_in_part_in_parts (parts):
2544 """return a Part -> Name -> Voice dictionary"""
2545 return dict([(p.id, voices_in_part (p)) for p in parts])
2548 def get_all_voices (parts):
2549 all_voices = voices_in_part_in_parts (parts)
2552 all_ly_staffinfo = {}
2553 for p, (name_voice, staff_info) in all_voices.items ():
2556 for n, v in name_voice.items ():
2557 progress (_ ("Converting to LilyPond expressions..."))
2558 # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
2559 part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
2561 all_ly_voices[p] = part_ly_voices
2562 all_ly_staffinfo[p] = staff_info
2564 return (all_ly_voices, all_ly_staffinfo)
2567 def option_parser ():
2568 p = ly.get_option_parser (usage = _ ("musicxml2ly [OPTION]... FILE.xml"),
2570 _ ("""Convert MusicXML from FILE.xml to LilyPond input.
2571 If the given filename is -, musicxml2ly reads from the command line.
2572 """), add_help_option=False)
2574 p.add_option("-h", "--help",
2576 help=_ ("show this help and exit"))
2578 p.version = ('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
2580 _ ("""Copyright (c) 2005--2009 by
2581 Han-Wen Nienhuys <hanwen@xs4all.nl>,
2582 Jan Nieuwenhuizen <janneke@gnu.org> and
2583 Reinhold Kainhofer <reinhold@kainhofer.com>
2587 This program is free software. It is covered by the GNU General Public
2588 License and you are welcome to change it and/or distribute copies of it
2589 under certain conditions. Invoke as `%s --warranty' for more
2590 information.""") % 'lilypond')
2592 p.add_option("--version",
2594 help=_ ("show version number and exit"))
2596 p.add_option ('-v', '--verbose',
2597 action = "store_true",
2599 help = _ ("be verbose"))
2601 p.add_option ('', '--lxml',
2602 action = "store_true",
2605 help = _ ("use lxml.etree; uses less memory and cpu time"))
2607 p.add_option ('-z', '--compressed',
2608 action = "store_true",
2609 dest = 'compressed',
2611 help = _ ("input file is a zip-compressed MusicXML file"))
2613 p.add_option ('-r', '--relative',
2614 action = "store_true",
2617 help = _ ("convert pitches in relative mode (default)"))
2619 p.add_option ('-a', '--absolute',
2620 action = "store_false",
2622 help = _ ("convert pitches in absolute mode"))
2624 p.add_option ('-l', '--language',
2625 metavar = _ ("LANG"),
2627 help = _ ("use a different language file 'LANG.ly' and corresponding pitch names, e.g. 'deutsch' for deutsch.ly"))
2629 p.add_option ('--nd', '--no-articulation-directions',
2630 action = "store_false",
2632 dest = "convert_directions",
2633 help = _ ("do not convert directions (^, _ or -) for articulations, dynamics, etc."))
2635 p.add_option ('--nrp', '--no-rest-positions',
2636 action = "store_false",
2638 dest = "convert_rest_positions",
2639 help = _ ("do not convert exact vertical positions of rests"))
2641 p.add_option ('--no-beaming',
2642 action = "store_false",
2644 dest = "convert_beaming",
2645 help = _ ("do not convert beaming information, use lilypond's automatic beaming instead"))
2647 p.add_option ('-o', '--output',
2648 metavar = _ ("FILE"),
2652 dest = 'output_name',
2653 help = _ ("set output filename to FILE, stdout if -"))
2654 p.add_option_group ('',
2656 _ ("Report bugs via %s")
2657 % 'http://post.gmane.org/post.php'
2658 '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
2661 def music_xml_voice_name_to_lily_name (part_id, name):
2662 str = "Part%sVoice%s" % (part_id, name)
2663 return musicxml_id_to_lily (str)
2665 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
2666 str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
2667 return musicxml_id_to_lily (str)
2669 def music_xml_figuredbass_name_to_lily_name (part_id, voicename):
2670 str = "Part%sVoice%sFiguredBass" % (part_id, voicename)
2671 return musicxml_id_to_lily (str)
2673 def music_xml_chordnames_name_to_lily_name (part_id, voicename):
2674 str = "Part%sVoice%sChords" % (part_id, voicename)
2675 return musicxml_id_to_lily (str)
2677 def print_voice_definitions (printer, part_list, voices):
2678 for part in part_list:
2680 nv_dict = voices.get (part_id, {})
2681 for (name, voice) in nv_dict.items ():
2682 k = music_xml_voice_name_to_lily_name (part_id, name)
2683 printer.dump ('%s = ' % k)
2684 voice.ly_voice.print_ly (printer)
2686 if voice.chordnames:
2687 cnname = music_xml_chordnames_name_to_lily_name (part_id, name)
2688 printer.dump ('%s = ' % cnname )
2689 voice.chordnames.print_ly (printer)
2691 for l in voice.lyrics_order:
2692 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
2693 printer.dump ('%s = ' % lname )
2694 voice.lyrics_dict[l].print_ly (printer)
2696 if voice.figured_bass:
2697 fbname = music_xml_figuredbass_name_to_lily_name (part_id, name)
2698 printer.dump ('%s = ' % fbname )
2699 voice.figured_bass.print_ly (printer)
2704 return dict ([(elt,1) for elt in l]).keys ()
2706 # format the information about the staff in the form
2709 # [voiceid1, [lyricsid11, lyricsid12,...], figuredbassid1],
2710 # [voiceid2, [lyricsid21, lyricsid22,...], figuredbassid2],
2714 # raw_voices is of the form [(voicename, lyricsids, havefiguredbass)*]
2715 def format_staff_info (part_id, staff_id, raw_voices):
2717 for (v, lyricsids, figured_bass, chordnames) in raw_voices:
2718 voice_name = music_xml_voice_name_to_lily_name (part_id, v)
2719 voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
2721 figured_bass_name = ''
2723 figured_bass_name = music_xml_figuredbass_name_to_lily_name (part_id, v)
2724 chordnames_name = ''
2726 chordnames_name = music_xml_chordnames_name_to_lily_name (part_id, v)
2727 voices.append ([voice_name, voice_lyrics, figured_bass_name, chordnames_name])
2728 return [staff_id, voices]
2730 def update_score_setup (score_structure, part_list, voices):
2732 for part_definition in part_list:
2733 part_id = part_definition.id
2734 nv_dict = voices.get (part_id)
2736 error_message (_ ('unknown part in part-list: %s') % part_id)
2739 staves = reduce (lambda x,y: x+ y,
2740 [voice.voicedata._staves.keys ()
2741 for voice in nv_dict.values ()],
2744 if len (staves) > 1:
2746 staves = uniq_list (staves)
2749 thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2750 for (voice_name, voice) in nv_dict.items ()
2751 if voice.voicedata._start_staff == s]
2752 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
2754 thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2755 for (voice_name, voice) in nv_dict.items ()]
2756 staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
2757 score_structure.set_part_information (part_id, staves_info)
2759 # Set global values in the \layout block, like auto-beaming etc.
2760 def update_layout_information ():
2761 if not conversion_settings.ignore_beaming and layout_information:
2762 layout_information.set_context_item ('Score', 'autoBeaming = ##f')
2764 def print_ly_preamble (printer, filename):
2765 printer.dump_version ()
2766 printer.print_verbatim ('%% automatically converted from %s\n' % filename)
2768 def print_ly_additional_definitions (printer, filename):
2769 if needed_additional_definitions:
2771 printer.print_verbatim ('%% additional definitions required by the score:')
2773 for a in set(needed_additional_definitions):
2774 printer.print_verbatim (additional_definitions.get (a, ''))
2778 # Read in the tree from the given I/O object (either file or string) and
2779 # demarshall it using the classes from the musicxml.py file
2780 def read_xml (io_object, use_lxml):
2783 tree = lxml.etree.parse (io_object)
2784 mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
2787 from xml.dom import minidom, Node
2788 doc = minidom.parse(io_object)
2789 node = doc.documentElement
2790 return musicxml.minidom_demarshal_node (node)
2794 def read_musicxml (filename, compressed, use_lxml):
2798 progress (_ ("Input is compressed, extracting raw MusicXML data from stdin") )
2799 z = zipfile.ZipFile (sys.stdin)
2801 progress (_ ("Input file %s is compressed, extracting raw MusicXML data") % filename)
2802 z = zipfile.ZipFile (filename, "r")
2803 container_xml = z.read ("META-INF/container.xml")
2804 if not container_xml:
2806 container = read_xml (StringIO.StringIO (container_xml), use_lxml)
2809 rootfiles = container.get_maybe_exist_named_child ('rootfiles')
2812 rootfile_list = rootfiles.get_named_children ('rootfile')
2814 if len (rootfile_list) > 0:
2815 mxml_file = getattr (rootfile_list[0], 'full-path', None)
2817 raw_string = z.read (mxml_file)
2820 io_object = StringIO.StringIO (raw_string)
2821 elif filename == "-":
2822 io_object = sys.stdin
2824 io_object = filename
2826 return read_xml (io_object, use_lxml)
2829 def convert (filename, options):
2831 progress (_ ("Reading MusicXML from Standard input ...") )
2833 progress (_ ("Reading MusicXML from %s ...") % filename)
2835 tree = read_musicxml (filename, options.compressed, options.use_lxml)
2836 score_information = extract_score_information (tree)
2837 paper_information = extract_paper_information (tree)
2839 parts = tree.get_typed_children (musicxml.Part)
2840 (voices, staff_info) = get_all_voices (parts)
2843 mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
2845 score = extract_score_structure (mxl_pl, staff_info)
2846 part_list = mxl_pl.get_named_children ("score-part")
2848 # score information is contained in the <work>, <identification> or <movement-title> tags
2849 update_score_setup (score, part_list, voices)
2850 # After the conversion, update the list of settings for the \layout block
2851 update_layout_information ()
2853 if not options.output_name:
2854 options.output_name = os.path.basename (filename)
2855 options.output_name = os.path.splitext (options.output_name)[0]
2856 elif re.match (".*\.ly", options.output_name):
2857 options.output_name = os.path.splitext (options.output_name)[0]
2860 #defs_ly_name = options.output_name + '-defs.ly'
2861 if (options.output_name == "-"):
2862 output_ly_name = 'Standard output'
2864 output_ly_name = options.output_name + '.ly'
2866 progress (_ ("Output to `%s'") % output_ly_name)
2867 printer = musicexp.Output_printer()
2868 #progress (_ ("Output to `%s'") % defs_ly_name)
2869 if (options.output_name == "-"):
2870 printer.set_file (codecs.getwriter ("utf-8")(sys.stdout))
2872 printer.set_file (codecs.open (output_ly_name, 'wb', encoding='utf-8'))
2873 print_ly_preamble (printer, filename)
2874 print_ly_additional_definitions (printer, filename)
2875 if score_information:
2876 score_information.print_ly (printer)
2877 if paper_information:
2878 paper_information.print_ly (printer)
2879 if layout_information:
2880 layout_information.print_ly (printer)
2881 print_voice_definitions (printer, part_list, voices)
2884 printer.dump ("% The score definition")
2886 score.print_ly (printer)
2891 def get_existing_filename_with_extension (filename, ext):
2892 if os.path.exists (filename):
2894 newfilename = filename + "." + ext
2895 if os.path.exists (newfilename):
2897 newfilename = filename + ext
2898 if os.path.exists (newfilename):
2903 opt_parser = option_parser()
2906 (options, args) = opt_parser.parse_args ()
2908 opt_parser.print_usage()
2911 if options.language:
2912 musicexp.set_pitch_language (options.language)
2913 needed_additional_definitions.append (options.language)
2914 additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
2915 conversion_settings.ignore_beaming = not options.convert_beaming
2917 # Allow the user to leave out the .xml or xml on the filename
2918 basefilename = args[0].decode('utf-8')
2919 if basefilename == "-": # Read from stdin
2922 filename = get_existing_filename_with_extension (basefilename, "xml")
2924 filename = get_existing_filename_with_extension (basefilename, "mxl")
2925 options.compressed = True
2926 if filename and filename.endswith ("mxl"):
2927 options.compressed = True
2929 if filename and (filename == "-" or os.path.exists (filename)):
2930 voices = convert (filename, options)
2932 progress (_ ("Unable to find input file %s") % basefilename)
2934 if __name__ == '__main__':