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 = {
47 "snappizzicato": """#(define-markup-command (snappizzicato layout props) ()
48 (interpret-markup layout props
50 (ly:stencil-translate-axis
52 (make-circle-stencil 0.7 0.1 #f)
54 (list 'draw-line 0.1 0 0.1 0 1)
55 '(-0.1 . 0.1) '(0.1 . 1)))
57 "eyeglasses": """eyeglassesps = #"0.15 setlinewidth
63 2.20 0.70 0.50 0 361 arc
65 1.45 0.85 0.30 0 180 arc
69 0.92 2.26 1.30 2.40 1.15 1.70 curveto
73 3.42 2.26 3.80 2.40 3.65 1.70 curveto
75 eyeglasses = \markup { \with-dimensions #'(0 . 4.4) #'(0 . 2.5) \postscript #eyeglassesps }"""
78 def round_to_two_digits (val):
79 return round (val * 100) / 100
81 def extract_paper_information (tree):
82 paper = musicexp.Paper ()
83 defaults = tree.get_maybe_exist_named_child ('defaults')
87 scaling = defaults.get_maybe_exist_named_child ('scaling')
89 mm = scaling.get_named_child ('millimeters')
90 mm = string.atof (mm.get_text ())
91 tn = scaling.get_maybe_exist_named_child ('tenths')
92 tn = string.atof (tn.get_text ())
94 paper.global_staff_size = mm * 72.27 / 25.4
95 # We need the scaling (i.e. the size of staff tenths for everything!
99 def from_tenths (txt):
100 return round_to_two_digits (string.atof (txt) * tenths / 10)
101 def set_paper_variable (varname, parent, element_name):
102 el = parent.get_maybe_exist_named_child (element_name)
103 if el: # Convert to cm from tenths
104 setattr (paper, varname, from_tenths (el.get_text ()))
106 pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
108 # TODO: How can one have different margins for even and odd pages???
109 set_paper_variable ("page_height", pagelayout, 'page-height')
110 set_paper_variable ("page_width", pagelayout, 'page-width')
112 pmargins = pagelayout.get_named_children ('page-margins')
114 set_paper_variable ("left_margin", pm, 'left-margin')
115 set_paper_variable ("right_margin", pm, 'right-margin')
116 set_paper_variable ("bottom_margin", pm, 'bottom-margin')
117 set_paper_variable ("top_margin", pm, 'top-margin')
119 systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
121 sl = systemlayout.get_maybe_exist_named_child ('system-margins')
123 set_paper_variable ("system_left_margin", sl, 'left-margin')
124 set_paper_variable ("system_right_margin", sl, 'right-margin')
125 set_paper_variable ("system_distance", systemlayout, 'system-distance')
126 set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
128 stafflayout = defaults.get_named_children ('staff-layout')
129 for sl in stafflayout:
130 nr = getattr (sl, 'number', 1)
131 dist = sl.get_named_child ('staff-distance')
132 #TODO: the staff distance needs to be set in the Staff context!!!
134 # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
135 appearance = defaults.get_named_child ('appearance')
137 lws = appearance.get_named_children ('line-width')
139 # Possible types are: beam, bracket, dashes,
140 # enclosure, ending, extend, heavy barline, leger,
141 # light barline, octave shift, pedal, slur middle, slur tip,
142 # staff, stem, tie middle, tie tip, tuplet bracket, and wedge
144 w = from_tenths (lw.get_text ())
145 # TODO: Do something with these values!
146 nss = appearance.get_named_children ('note-size')
148 # Possible types are: cue, grace and large
150 sz = from_tenths (ns.get_text ())
151 # TODO: Do something with these values!
152 # <other-appearance> elements have no specified meaning
154 rawmusicfont = defaults.get_named_child ('music-font')
156 # TODO: Convert the font
158 rawwordfont = defaults.get_named_child ('word-font')
160 # TODO: Convert the font
162 rawlyricsfonts = defaults.get_named_children ('lyric-font')
163 for lyricsfont in rawlyricsfonts:
164 # TODO: Convert the font
171 # score information is contained in the <work>, <identification> or <movement-title> tags
172 # extract those into a hash, indexed by proper lilypond header attributes
173 def extract_score_information (tree):
174 header = musicexp.Header ()
175 def set_if_exists (field, value):
177 header.set_field (field, musicxml.escape_ly_output_string (value))
179 work = tree.get_maybe_exist_named_child ('work')
181 set_if_exists ('title', work.get_work_title ())
182 set_if_exists ('worknumber', work.get_work_number ())
183 set_if_exists ('opus', work.get_opus ())
185 movement_title = tree.get_maybe_exist_named_child ('movement-title')
187 set_if_exists ('title', movement_title.get_text ())
189 identifications = tree.get_named_children ('identification')
190 for ids in identifications:
191 set_if_exists ('copyright', ids.get_rights ())
192 set_if_exists ('composer', ids.get_composer ())
193 set_if_exists ('arranger', ids.get_arranger ())
194 set_if_exists ('editor', ids.get_editor ())
195 set_if_exists ('poet', ids.get_poet ())
197 set_if_exists ('tagline', ids.get_encoding_software ())
198 set_if_exists ('encodingsoftware', ids.get_encoding_software ())
199 set_if_exists ('encodingdate', ids.get_encoding_date ())
200 set_if_exists ('encoder', ids.get_encoding_person ())
201 set_if_exists ('encodingdescription', ids.get_encoding_description ())
203 set_if_exists ('texidoc', ids.get_file_description ());
205 # Finally, apply the required compatibility modes
206 # Some applications created wrong MusicXML files, so we need to
207 # apply some compatibility mode, e.g. ignoring some features/tags
209 software = ids.get_encoding_software_list ()
211 # Case 1: "Sibelius 5.1" with the "Dolet 3.4 for Sibelius" plugin
212 # is missing all beam ends => ignore all beaming information
213 if "Dolet 3.4 for Sibelius" in software:
214 conversion_settings.ignore_beaming = True
215 progress (_ ("Encountered file created by Dolet 3.4 for Sibelius, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
216 if "Noteworthy Composer" in software:
217 conversion_settings.ignore_beaming = True
218 progress (_ ("Encountered file created by Noteworthy Composer's nwc2xml, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
219 # TODO: Check for other unsupported features
228 return len (self.start) + len (self.end) == 0
229 def add_start (self, g):
230 self.start[getattr (g, 'number', "1")] = g
231 def add_end (self, g):
232 self.end[getattr (g, 'number', "1")] = g
233 def print_ly (self, printer):
234 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
235 def ly_expression (self):
236 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
239 def staff_attributes_to_string_tunings (mxl_attr):
240 details = mxl_attr.get_maybe_exist_named_child ('staff-details')
244 staff_lines = details.get_maybe_exist_named_child ('staff-lines')
246 lines = string.atoi (staff_lines.get_text ())
249 staff_tunings = details.get_named_children ('staff-tuning')
250 for i in staff_tunings:
254 line = string.atoi (i.line) - 1
259 step = i.get_named_child (u'tuning-step')
260 step = step.get_text ().strip ()
261 p.step = musicxml_step_to_lily (step)
263 octave = i.get_named_child (u'tuning-octave')
264 octave = octave.get_text ().strip ()
265 p.octave = int (octave) - 4
267 alter = i.get_named_child (u'tuning-alter')
269 p.alteration = int (alter.get_text ().strip ())
270 # lilypond seems to use the opposite ordering than MusicXML...
276 def staff_attributes_to_lily_staff (mxl_attr):
278 return musicexp.Staff ()
280 (staff_id, attributes) = mxl_attr.items ()[0]
282 # distinguish by clef:
283 # percussion (percussion and rhythmic), tab, and everything else
285 clef = attributes.get_maybe_exist_named_child ('clef')
287 sign = clef.get_maybe_exist_named_child ('sign')
289 clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
292 details = attributes.get_named_children ('staff-details')
294 staff_lines = d.get_maybe_exist_named_child ('staff-lines')
296 lines = string.atoi (staff_lines.get_text ())
299 if clef_sign == "percussion" and lines == 1:
300 staff = musicexp.RhythmicStaff ()
301 elif clef_sign == "percussion":
302 staff = musicexp.DrumStaff ()
303 # staff.drum_style_table = ???
304 elif clef_sign == "tab":
305 staff = musicexp.TabStaff ()
306 staff.string_tunings = staff_attributes_to_string_tunings (attributes)
307 # staff.tablature_format = ???
309 # TODO: Handle case with lines <> 5!
310 staff = musicexp.Staff ()
315 def extract_score_structure (part_list, staffinfo):
316 score = musicexp.Score ()
317 structure = musicexp.StaffGroup (None)
318 score.set_contents (structure)
323 def read_score_part (el):
324 if not isinstance (el, musicxml.Score_part):
326 # Depending on the attributes of the first measure, we create different
327 # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
328 staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
332 partname = el.get_maybe_exist_named_child ('part-name')
333 # Finale gives unnamed parts the name "MusicXML Part" automatically!
334 if partname and partname.get_text() != "MusicXML Part":
335 staff.instrument_name = partname.get_text ()
336 if el.get_maybe_exist_named_child ('part-abbreviation'):
337 staff.short_instrument_name = el.get_maybe_exist_named_child ('part-abbreviation').get_text ()
338 # TODO: Read in the MIDI device / instrument
341 def read_score_group (el):
342 if not isinstance (el, musicxml.Part_group):
344 group = musicexp.StaffGroup ()
345 if hasattr (el, 'number'):
348 #currentgroups_dict[id] = group
349 #currentgroups.append (id)
350 if el.get_maybe_exist_named_child ('group-name'):
351 group.instrument_name = el.get_maybe_exist_named_child ('group-name').get_text ()
352 if el.get_maybe_exist_named_child ('group-abbreviation'):
353 group.short_instrument_name = el.get_maybe_exist_named_child ('group-abbreviation').get_text ()
354 if el.get_maybe_exist_named_child ('group-symbol'):
355 group.symbol = el.get_maybe_exist_named_child ('group-symbol').get_text ()
356 if el.get_maybe_exist_named_child ('group-barline'):
357 group.spanbar = el.get_maybe_exist_named_child ('group-barline').get_text ()
361 parts_groups = part_list.get_all_children ()
363 # the start/end group tags are not necessarily ordered correctly and groups
364 # might even overlap, so we can't go through the children sequentially!
366 # 1) Replace all Score_part objects by their corresponding Staff objects,
367 # also collect all group start/stop points into one PartGroupInfo object
369 group_info = PartGroupInfo ()
370 for el in parts_groups:
371 if isinstance (el, musicxml.Score_part):
372 if not group_info.is_empty ():
373 staves.append (group_info)
374 group_info = PartGroupInfo ()
375 staff = read_score_part (el)
377 staves.append (staff)
378 elif isinstance (el, musicxml.Part_group):
379 if el.type == "start":
380 group_info.add_start (el)
381 elif el.type == "stop":
382 group_info.add_end (el)
383 if not group_info.is_empty ():
384 staves.append (group_info)
386 # 2) Now, detect the groups:
389 while pos < len (staves):
391 if isinstance (el, PartGroupInfo):
393 if len (group_starts) > 0:
394 prev_start = group_starts[-1]
395 elif len (el.end) > 0: # no group to end here
397 if len (el.end) > 0: # closes an existing group
398 ends = el.end.keys ()
399 prev_started = staves[prev_start].start.keys ()
401 intersection = filter(lambda x:x in ends, prev_started)
402 if len (intersection) > 0:
403 grpid = intersection[0]
405 # Close the last started group
406 grpid = staves[prev_start].start.keys () [0]
407 # Find the corresponding closing tag and remove it!
410 while j < len (staves) and not foundclosing:
411 if isinstance (staves[j], PartGroupInfo) and staves[j].end.has_key (grpid):
413 del staves[j].end[grpid]
414 if staves[j].is_empty ():
417 grpobj = staves[prev_start].start[grpid]
418 group = read_score_group (grpobj)
419 # remove the id from both the start and end
420 if el.end.has_key (grpid):
422 del staves[prev_start].start[grpid]
425 # replace the staves with the whole group
426 for j in staves[(prev_start + 1):pos]:
428 j.stafftype = "InnerStaffGroup"
429 group.append_staff (j)
430 del staves[(prev_start + 1):pos]
431 staves.insert (prev_start + 1, group)
432 # reset pos so that we continue at the correct position
434 # remove an empty start group
435 if staves[prev_start].is_empty ():
436 del staves[prev_start]
437 group_starts.remove (prev_start)
439 elif len (el.start) > 0: # starts new part groups
440 group_starts.append (pos)
443 if len (staves) == 1:
446 structure.append_staff (i)
450 def musicxml_duration_to_lily (mxl_note):
451 d = musicexp.Duration ()
452 # if the note has no Type child, then that method spits out a warning and
453 # returns 0, i.e. a whole note
454 d.duration_log = mxl_note.get_duration_log ()
456 d.dots = len (mxl_note.get_typed_children (musicxml.Dot))
457 # Grace notes by specification have duration 0, so no time modification
458 # factor is possible. It even messes up the output with *0/1
459 if not mxl_note.get_maybe_exist_typed_child (musicxml.Grace):
460 d.factor = mxl_note._duration / d.get_length ()
464 def rational_to_lily_duration (rational_len):
465 d = musicexp.Duration ()
467 rational_len.normalize_self ()
468 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)
470 # Duration of the form 1/2^n or 3/2^n can be converted to a simple lilypond duration
471 if (d_log >= 0 and rational_len.numerator() in (1,3,5,7) ):
472 # account for the dots!
473 d.dots = (rational_len.numerator()-1)/2
474 d.duration_log = d_log - d.dots
476 d.duration_log = d_log
477 d.factor = Rational (rational_len.numerator ())
479 error_message (_ ("Encountered rational duration with denominator %s, "
480 "unable to convert to lilypond duration") %
481 rational_len.denominator ())
482 # TODO: Test the above error message
487 def musicxml_partial_to_lily (partial_len):
489 p = musicexp.Partial ()
490 p.partial = rational_to_lily_duration (partial_len)
495 # Detect repeats and alternative endings in the chord event list (music_list)
496 # and convert them to the corresponding musicexp objects, containing nested
498 def group_repeats (music_list):
499 repeat_replaced = True
502 # Walk through the list of expressions, looking for repeat structure
503 # (repeat start/end, corresponding endings). If we find one, try to find the
504 # last event of the repeat, replace the whole structure and start over again.
505 # For nested repeats, as soon as we encounter another starting repeat bar,
506 # treat that one first, and start over for the outer repeat.
507 while repeat_replaced and i < 100:
509 repeat_start = -1 # position of repeat start / end
510 repeat_end = -1 # position of repeat start / end
512 ending_start = -1 # position of current ending start
513 endings = [] # list of already finished endings
515 last = len (music_list) - 1
516 repeat_replaced = False
518 while pos < len (music_list) and not repeat_replaced:
520 repeat_finished = False
521 if isinstance (e, RepeatMarker):
522 if not repeat_times and e.times:
523 repeat_times = e.times
524 if e.direction == -1:
526 repeat_finished = True
532 elif e.direction == 1:
538 elif isinstance (e, EndingMarker):
539 if e.direction == -1:
545 elif e.direction == 1:
548 endings.append ([ending_start, pos])
551 elif not isinstance (e, musicexp.BarLine):
552 # As soon as we encounter an element when repeat start and end
553 # is set and we are not inside an alternative ending,
554 # this whole repeat structure is finished => replace it
555 if repeat_start >= 0 and repeat_end > 0 and ending_start < 0:
556 repeat_finished = True
558 # Finish off all repeats without explicit ending bar (e.g. when
559 # we convert only one page of a multi-page score with repeats)
560 if pos == last and repeat_start >= 0:
561 repeat_finished = True
565 if ending_start >= 0:
566 endings.append ([ending_start, pos])
570 # We found the whole structure replace it!
571 r = musicexp.RepeatedMusic ()
572 if repeat_times <= 0:
574 r.repeat_count = repeat_times
575 # don't erase the first element for "implicit" repeats (i.e. no
576 # starting repeat bars at the very beginning)
577 start = repeat_start+1
578 if repeat_start == music_start:
580 r.set_music (music_list[start:repeat_end])
581 for (start, end) in endings:
582 s = musicexp.SequentialMusic ()
583 s.elements = music_list[start+1:end]
585 del music_list[repeat_start:final_marker+1]
586 music_list.insert (repeat_start, r)
587 repeat_replaced = True
589 # TODO: Implement repeats until the end without explicit ending bar
594 def group_tuplets (music_list, events):
597 """Collect Musics from
598 MUSIC_LIST demarcated by EVENTS_LIST in TimeScaledMusic objects.
605 for (ev_chord, tuplet_elt, fraction) in events:
606 while (j < len (music_list)):
607 if music_list[j] == ev_chord:
610 if tuplet_elt.type == 'start':
611 indices.append ((j, None, fraction))
612 elif tuplet_elt.type == 'stop':
613 indices[-1] = (indices[-1][0], j, indices[-1][2])
617 for (i1, i2, frac) in indices:
621 new_list.extend (music_list[last:i1])
622 seq = musicexp.SequentialMusic ()
624 seq.elements = music_list[i1:last]
626 tsm = musicexp.TimeScaledMusic ()
629 tsm.numerator = frac[0]
630 tsm.denominator = frac[1]
632 new_list.append (tsm)
634 new_list.extend (music_list[last:])
638 def musicxml_clef_to_lily (attributes):
639 change = musicexp.ClefChange ()
640 (change.type, change.position, change.octave) = attributes.get_clef_information ()
643 def musicxml_time_to_lily (attributes):
644 (beats, type) = attributes.get_time_signature ()
646 change = musicexp.TimeSignatureChange()
647 change.fraction = (beats, type)
651 def musicxml_key_to_lily (attributes):
652 start_pitch = musicexp.Pitch ()
653 (fifths, mode) = attributes.get_key_signature ()
667 start_pitch.alteration = a
669 error_message (_ ("unknown mode %s, expecting 'major' or 'minor'") % mode)
671 fifth = musicexp.Pitch()
678 for x in range (fifths):
679 start_pitch = start_pitch.transposed (fifth)
681 start_pitch.octave = 0
683 change = musicexp.KeySignatureChange()
685 change.tonic = start_pitch
688 def musicxml_attributes_to_lily (attrs):
691 'clef': musicxml_clef_to_lily,
692 'time': musicxml_time_to_lily,
693 'key': musicxml_key_to_lily
695 for (k, func) in attr_dispatch.items ():
696 children = attrs.get_named_children (k)
698 elts.append (func (attrs))
702 class Marker (musicexp.Music):
706 def print_ly (self, printer):
707 ly.stderr_write (_ ("Encountered unprocessed marker %s\n") % self)
709 def ly_expression (self):
711 class RepeatMarker (Marker):
713 Marker.__init__ (self)
715 class EndingMarker (Marker):
718 # Convert the <barline> element to musicxml.BarLine (for non-standard barlines)
719 # and to RepeatMarker and EndingMarker objects for repeat and
720 # alternatives start/stops
721 def musicxml_barline_to_lily (barline):
722 # retval contains all possible markers in the order:
723 # 0..bw_ending, 1..bw_repeat, 2..barline, 3..fw_repeat, 4..fw_ending
725 bartype_element = barline.get_maybe_exist_named_child ("bar-style")
726 repeat_element = barline.get_maybe_exist_named_child ("repeat")
727 ending_element = barline.get_maybe_exist_named_child ("ending")
731 bartype = bartype_element.get_text ()
733 if repeat_element and hasattr (repeat_element, 'direction'):
734 repeat = RepeatMarker ()
735 repeat.direction = {"forward": -1, "backward": 1}.get (repeat_element.direction, 0)
737 if ( (repeat_element.direction == "forward" and bartype == "heavy-light") or
738 (repeat_element.direction == "backward" and bartype == "light-heavy") ):
740 if hasattr (repeat_element, 'times'):
742 repeat.times = int (repeat_element.times)
745 repeat.event = barline
746 if repeat.direction == -1:
751 if ending_element and hasattr (ending_element, 'type'):
752 ending = EndingMarker ()
753 ending.direction = {"start": -1, "stop": 1, "discontinue": 1}.get (ending_element.type, 0)
754 ending.event = barline
755 if ending.direction == -1:
761 b = musicexp.BarLine ()
765 return retval.values ()
767 spanner_event_dict = {
768 'beam' : musicexp.BeamEvent,
769 'dashes' : musicexp.TextSpannerEvent,
770 'bracket' : musicexp.BracketSpannerEvent,
771 'glissando' : musicexp.GlissandoEvent,
772 'octave-shift' : musicexp.OctaveShiftEvent,
773 'pedal' : musicexp.PedalEvent,
774 'slide' : musicexp.GlissandoEvent,
775 'slur' : musicexp.SlurEvent,
776 'wavy-line' : musicexp.TrillSpanEvent,
777 'wedge' : musicexp.HairpinEvent
779 spanner_type_dict = {
793 def musicxml_spanner_to_lily_event (mxl_event):
796 name = mxl_event.get_name()
797 func = spanner_event_dict.get (name)
801 error_message (_ ('unknown span event %s') % mxl_event)
804 type = mxl_event.get_type ()
805 span_direction = spanner_type_dict.get (type)
806 # really check for None, because some types will be translated to 0, which
807 # would otherwise also lead to the unknown span warning
808 if span_direction != None:
809 ev.span_direction = span_direction
811 error_message (_ ('unknown span type %s for %s') % (type, name))
813 ev.set_span_type (type)
814 ev.line_type = getattr (mxl_event, 'line-type', 'solid')
816 # assign the size, which is used for octave-shift, etc.
817 ev.size = mxl_event.get_size ()
821 def musicxml_direction_to_indicator (direction):
822 return { "above": 1, "upright": 1, "up": 1, "below": -1, "downright": -1, "down": -1, "inverted": -1 }.get (direction, 0)
824 def musicxml_fermata_to_lily_event (mxl_event):
825 ev = musicexp.ArticulationEvent ()
826 txt = mxl_event.get_text ()
827 # The contents of the element defined the shape, possible are normal, angled and square
828 ev.type = { "angled": "shortfermata", "square": "longfermata" }.get (txt, "fermata")
829 if hasattr (mxl_event, 'type'):
830 dir = musicxml_direction_to_indicator (mxl_event.type)
831 if dir and options.convert_directions:
832 ev.force_direction = dir
835 def musicxml_arpeggiate_to_lily_event (mxl_event):
836 ev = musicexp.ArpeggioEvent ()
837 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
840 def musicxml_nonarpeggiate_to_lily_event (mxl_event):
841 ev = musicexp.ArpeggioEvent ()
842 ev.non_arpeggiate = True
843 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
846 def musicxml_tremolo_to_lily_event (mxl_event):
847 ev = musicexp.TremoloEvent ()
848 txt = mxl_event.get_text ()
855 def musicxml_falloff_to_lily_event (mxl_event):
856 ev = musicexp.BendEvent ()
860 def musicxml_doit_to_lily_event (mxl_event):
861 ev = musicexp.BendEvent ()
865 def musicxml_bend_to_lily_event (mxl_event):
866 ev = musicexp.BendEvent ()
867 ev.alter = mxl_event.bend_alter ()
870 def musicxml_caesura_to_lily_event (mxl_event):
871 ev = musicexp.MarkupEvent ()
872 # FIXME: default to straight or curved caesura?
873 ev.contents = "\\musicglyph #\"scripts.caesura.straight\""
874 ev.force_direction = 1
877 def musicxml_fingering_event (mxl_event):
878 ev = musicexp.ShortArticulationEvent ()
879 ev.type = mxl_event.get_text ()
882 def musicxml_snappizzicato_event (mxl_event):
883 needed_additional_definitions.append ("snappizzicato")
884 ev = musicexp.MarkupEvent ()
885 ev.contents = "\\snappizzicato"
888 def musicxml_string_event (mxl_event):
889 ev = musicexp.NoDirectionArticulationEvent ()
890 ev.type = mxl_event.get_text ()
893 def musicxml_accidental_mark (mxl_event):
894 ev = musicexp.MarkupEvent ()
895 contents = { "sharp": "\\sharp",
896 "natural": "\\natural",
898 "double-sharp": "\\doublesharp",
899 "sharp-sharp": "\\sharp\\sharp",
900 "flat-flat": "\\flat\\flat",
901 "flat-flat": "\\doubleflat",
902 "natural-sharp": "\\natural\\sharp",
903 "natural-flat": "\\natural\\flat",
904 "quarter-flat": "\\semiflat",
905 "quarter-sharp": "\\semisharp",
906 "three-quarters-flat": "\\sesquiflat",
907 "three-quarters-sharp": "\\sesquisharp",
908 }.get (mxl_event.get_text ())
910 ev.contents = contents
915 # translate articulations, ornaments and other notations into ArticulationEvents
917 # -) string (ArticulationEvent with that name)
918 # -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
919 # -) (class, name) (like string, only that a different class than ArticulationEvent is used)
920 # TODO: Some translations are missing!
921 articulations_dict = {
922 "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
923 "accidental-mark": musicxml_accidental_mark,
924 "bend": musicxml_bend_to_lily_event,
925 "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
926 "caesura": musicxml_caesura_to_lily_event,
927 #"delayed-turn": "?",
928 "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
929 "doit": musicxml_doit_to_lily_event,
930 #"double-tongue": "?",
931 "down-bow": "downbow",
932 "falloff": musicxml_falloff_to_lily_event,
933 "fingering": musicxml_fingering_event,
937 "harmonic": "flageolet",
939 "inverted-mordent": "prall",
940 "inverted-turn": "reverseturn",
941 "mordent": "mordent",
942 "open-string": "open",
949 "snap-pizzicato": musicxml_snappizzicato_event,
951 "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
952 "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
953 "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
955 "string": musicxml_string_event,
956 "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
958 "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
959 "thumb-position": "thumb",
962 "tremolo": musicxml_tremolo_to_lily_event,
963 "trill-mark": "trill",
964 #"triple-tongue": "?",
969 articulation_spanners = [ "wavy-line" ]
971 def musicxml_articulation_to_lily_event (mxl_event):
972 # wavy-line elements are treated as trill spanners, not as articulation ornaments
973 if mxl_event.get_name () in articulation_spanners:
974 return musicxml_spanner_to_lily_event (mxl_event)
976 tmp_tp = articulations_dict.get (mxl_event.get_name ())
980 if isinstance (tmp_tp, str):
981 ev = musicexp.ArticulationEvent ()
983 elif isinstance (tmp_tp, tuple):
987 ev = tmp_tp (mxl_event)
989 # Some articulations use the type attribute, other the placement...
991 if hasattr (mxl_event, 'type') and options.convert_directions:
992 dir = musicxml_direction_to_indicator (mxl_event.type)
993 if hasattr (mxl_event, 'placement') and options.convert_directions:
994 dir = musicxml_direction_to_indicator (mxl_event.placement)
996 ev.force_direction = dir
1001 def musicxml_dynamics_to_lily_event (dynentry):
1002 dynamics_available = (
1003 "ppppp", "pppp", "ppp", "pp", "p", "mp", "mf",
1004 "f", "ff", "fff", "ffff", "fp", "sf", "sff", "sp", "spp", "sfz", "rfz" )
1005 dynamicsname = dynentry.get_name ()
1006 if dynamicsname == "other-dynamics":
1007 dynamicsname = dynentry.get_text ()
1008 if not dynamicsname or dynamicsname=="#text":
1011 if not dynamicsname in dynamics_available:
1012 # Get rid of - in tag names (illegal in ly tags!)
1013 dynamicstext = dynamicsname
1014 dynamicsname = string.replace (dynamicsname, "-", "")
1015 additional_definitions[dynamicsname] = dynamicsname + \
1016 " = #(make-dynamic-script \"" + dynamicstext + "\")"
1017 needed_additional_definitions.append (dynamicsname)
1018 event = musicexp.DynamicsEvent ()
1019 event.type = dynamicsname
1022 # Convert single-color two-byte strings to numbers 0.0 - 1.0
1023 def hexcolorval_to_nr (hex_val):
1025 v = int (hex_val, 16)
1032 def hex_to_color (hex_val):
1033 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)
1035 return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
1039 def musicxml_words_to_lily_event (words):
1040 event = musicexp.TextEvent ()
1041 text = words.get_text ()
1042 text = re.sub ('^ *\n? *', '', text)
1043 text = re.sub (' *\n? *$', '', text)
1046 if hasattr (words, 'default-y') and options.convert_directions:
1047 offset = getattr (words, 'default-y')
1049 off = string.atoi (offset)
1051 event.force_direction = 1
1053 event.force_direction = -1
1055 event.force_direction = 0
1057 if hasattr (words, 'font-weight'):
1058 font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
1060 event.markup += font_weight
1062 if hasattr (words, 'font-size'):
1063 size = getattr (words, 'font-size')
1065 "xx-small": '\\teeny',
1066 "x-small": '\\tiny',
1070 "x-large": '\\huge',
1071 "xx-large": '\\larger\\huge'
1074 event.markup += font_size
1076 if hasattr (words, 'color'):
1077 color = getattr (words, 'color')
1078 rgb = hex_to_color (color)
1080 event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
1082 if hasattr (words, 'font-style'):
1083 font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
1085 event.markup += font_style
1087 # TODO: How should I best convert the font-family attribute?
1089 # TODO: How can I represent the underline, overline and line-through
1090 # attributes in Lilypond? Values of these attributes indicate
1091 # the number of lines
1096 # convert accordion-registration to lilypond.
1097 # Since lilypond does not have any built-in commands, we need to create
1098 # the markup commands manually and define our own variables.
1099 # Idea was taken from: http://lsr.dsi.unimi.it/LSR/Item?id=194
1100 def musicxml_accordion_to_markup (mxl_event):
1101 commandname = "accReg"
1104 high = mxl_event.get_maybe_exist_named_child ('accordion-high')
1107 command += """\\combine
1108 \\raise #2.5 \\musicglyph #\"accordion.accDot\"
1110 middle = mxl_event.get_maybe_exist_named_child ('accordion-middle')
1112 # By default, use one dot (when no or invalid content is given). The
1113 # MusicXML spec is quiet about this case...
1116 txt = string.atoi (middle.get_text ())
1120 commandname += "MMM"
1121 command += """\\combine
1122 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1124 \\raise #1.5 \\translate #(cons 1 0) \\musicglyph #\"accordion.accDot\"
1126 \\raise #1.5 \\translate #(cons -1 0) \\musicglyph #\"accordion.accDot\"
1130 command += """\\combine
1131 \\raise #1.5 \\translate #(cons 0.5 0) \\musicglyph #\"accordion.accDot\"
1133 \\raise #1.5 \\translate #(cons -0.5 0) \\musicglyph #\"accordion.accDot\"
1137 command += """\\combine
1138 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1140 low = mxl_event.get_maybe_exist_named_child ('accordion-low')
1143 command += """\\combine
1144 \\raise #0.5 \musicglyph #\"accordion.accDot\"
1147 command += "\musicglyph #\"accordion.accDiscant\""
1148 command = "\\markup { \\normalsize %s }" % command
1149 # Define the newly built command \accReg[H][MMM][L]
1150 additional_definitions[commandname] = "%s = %s" % (commandname, command)
1151 needed_additional_definitions.append (commandname)
1152 return "\\%s" % commandname
1154 def musicxml_accordion_to_ly (mxl_event):
1155 txt = musicxml_accordion_to_markup (mxl_event)
1157 ev = musicexp.MarkEvent (txt)
1162 def musicxml_rehearsal_to_ly_mark (mxl_event):
1163 text = mxl_event.get_text ()
1166 # default is boxed rehearsal marks!
1168 if hasattr (mxl_event, 'enclosure'):
1169 encl = {"none": None, "square": "box", "circle": "circle" }.get (mxl_event.enclosure, None)
1171 text = "\\%s { %s }" % (encl, text)
1172 ev = musicexp.MarkEvent ("\\markup { %s }" % text)
1175 def musicxml_harp_pedals_to_ly (mxl_event):
1177 result = "\\harp-pedal #\""
1178 for t in mxl_event.get_named_children ('pedal-tuning'):
1179 alter = t.get_named_child ('pedal-alter')
1181 val = int (alter.get_text ().strip ())
1182 result += {1: "v", 0: "-", -1: "^"}.get (val, "")
1186 ev = musicexp.MarkupEvent ()
1187 ev.contents = result + "\""
1190 def musicxml_eyeglasses_to_ly (mxl_event):
1191 needed_additional_definitions.append ("eyeglasses")
1192 return musicexp.MarkEvent ("\\eyeglasses")
1194 def next_non_hash_index (lst, pos):
1196 while pos < len (lst) and isinstance (lst[pos], musicxml.Hash_text):
1200 def musicxml_metronome_to_ly (mxl_event):
1201 children = mxl_event.get_all_children ()
1206 index = next_non_hash_index (children, index)
1207 if isinstance (children[index], musicxml.BeatUnit):
1208 # first form of metronome-mark, using unit and beats/min or other unit
1209 ev = musicexp.TempoMark ()
1210 if hasattr (mxl_event, 'parentheses'):
1211 ev.set_parentheses (mxl_event.parentheses == "yes")
1213 d = musicexp.Duration ()
1214 d.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1215 index = next_non_hash_index (children, index)
1216 if isinstance (children[index], musicxml.BeatUnitDot):
1218 index = next_non_hash_index (children, index)
1219 ev.set_base_duration (d)
1220 if isinstance (children[index], musicxml.BeatUnit):
1221 # Form "note = newnote"
1222 newd = musicexp.Duration ()
1223 newd.duration_log = musicxml.musicxml_duration_to_log (children[index].get_text ())
1224 index = next_non_hash_index (children, index)
1225 if isinstance (children[index], musicxml.BeatUnitDot):
1227 index = next_non_hash_index (children, index)
1228 ev.set_new_duration (newd)
1229 elif isinstance (children[index], musicxml.PerMinute):
1232 beats = int (children[index].get_text ())
1233 ev.set_beats_per_minute (beats)
1237 error_message (_ ("Unknown metronome mark, ignoring"))
1241 #TODO: Implement the other (more complex) way for tempo marks!
1242 error_message (_ ("Metronome marks with complex relations (<metronome-note> in MusicXML) are not yet implemented."))
1245 # translate directions into Events, possible values:
1246 # -) string (MarkEvent with that command)
1247 # -) function (function(mxl_event) needs to return a full Event-derived object
1248 # -) (class, name) (like string, only that a different class than MarkEvent is used)
1250 'accordion-registration' : musicxml_accordion_to_ly,
1251 'coda' : (musicexp.MusicGlyphMarkEvent, "coda"),
1254 'eyeglasses': musicxml_eyeglasses_to_ly,
1255 'harp-pedals' : musicxml_harp_pedals_to_ly,
1257 'metronome' : musicxml_metronome_to_ly,
1258 'rehearsal' : musicxml_rehearsal_to_ly_mark,
1259 # 'scordatura' : ???
1260 'segno' : (musicexp.MusicGlyphMarkEvent, "segno"),
1261 'words' : musicxml_words_to_lily_event,
1263 directions_spanners = [ 'octave-shift', 'pedal', 'wedge', 'dashes', 'bracket' ]
1265 def musicxml_direction_to_lily (n):
1266 # TODO: Handle the <staff> element!
1268 # placement applies to all children!
1270 if hasattr (n, 'placement') and options.convert_directions:
1271 dir = musicxml_direction_to_indicator (n.placement)
1272 dirtype_children = []
1273 # TODO: The direction-type is used for grouping (e.g. dynamics with text),
1274 # so we can't simply flatten them out!
1275 for dt in n.get_typed_children (musicxml.DirType):
1276 dirtype_children += dt.get_all_children ()
1278 for entry in dirtype_children:
1279 # backets, dashes, octave shifts. pedal marks, hairpins etc. are spanners:
1280 if entry.get_name() in directions_spanners:
1281 event = musicxml_spanner_to_lily_event (entry)
1286 # now treat all the "simple" ones, that can be translated using the dict
1288 tmp_tp = directions_dict.get (entry.get_name (), None)
1289 if isinstance (tmp_tp, str): # string means MarkEvent
1290 ev = musicexp.MarkEvent (tmp_tp)
1291 elif isinstance (tmp_tp, tuple): # tuple means (EventClass, "text")
1292 ev = tmp_tp[0] (tmp_tp[1])
1296 # TODO: set the correct direction! Unfortunately, \mark in ly does
1297 # not seem to support directions!
1301 if entry.get_name () == "dynamics":
1302 for dynentry in entry.get_all_children ():
1303 ev = musicxml_dynamics_to_lily_event (dynentry)
1309 def musicxml_frame_to_lily_event (frame):
1310 ev = musicexp.FretEvent ()
1311 ev.strings = frame.get_strings ()
1312 ev.frets = frame.get_frets ()
1313 #offset = frame.get_first_fret () - 1
1315 for fn in frame.get_named_children ('frame-note'):
1316 fret = fn.get_fret ()
1319 el = [ fn.get_string (), fret ]
1320 fingering = fn.get_fingering ()
1322 el.append (fingering)
1323 ev.elements.append (el)
1326 barre[0] = el[0] # start string
1327 barre[2] = el[1] # fret
1329 barre[1] = el[0] # end string
1334 def musicxml_harmony_to_lily (n):
1336 for f in n.get_named_children ('frame'):
1337 ev = musicxml_frame_to_lily_event (f)
1343 def musicxml_chordpitch_to_lily (mxl_cpitch):
1344 r = musicexp.ChordPitch ()
1345 r.alteration = mxl_cpitch.get_alteration ()
1346 r.step = musicxml_step_to_lily (mxl_cpitch.get_step ())
1352 'augmented': 'aug5',
1353 'diminished': 'dim5',
1356 'major-seventh': 'maj7',
1357 'minor-seventh': 'm7',
1358 'diminished-seventh': 'dim7',
1359 'augmented-seventh': 'aug7',
1360 'half-diminished': 'dim5m7',
1361 'major-minor': 'maj7m5',
1364 'minor-sixth': 'm6',
1366 'dominant-ninth': '9',
1367 'major-ninth': 'maj9',
1368 'minor-ninth': 'm9',
1369 # 11ths (usually as the basis for alteration):
1370 'dominant-11th': '11',
1371 'major-11th': 'maj11',
1372 'minor-11th': 'm11',
1373 # 13ths (usually as the basis for alteration):
1374 'dominant-13th': '13.11',
1375 'major-13th': 'maj13.11',
1376 'minor-13th': 'm13',
1378 'suspended-second': 'sus2',
1379 'suspended-fourth': 'sus4',
1380 # Functional sixths:
1382 #'Neapolitan': '???',
1387 #'pedal': '???',(pedal-point bass)
1394 def musicxml_chordkind_to_lily (kind):
1395 res = chordkind_dict.get (kind, None)
1396 # Check for None, since a major chord is converted to ''
1398 error_message (_ ("Unable to convert chord type %s to lilypond.") % kind)
1401 def musicxml_harmony_to_lily_chordname (n):
1403 root = n.get_maybe_exist_named_child ('root')
1405 ev = musicexp.ChordNameEvent ()
1406 ev.root = musicxml_chordpitch_to_lily (root)
1407 kind = n.get_maybe_exist_named_child ('kind')
1409 ev.kind = musicxml_chordkind_to_lily (kind.get_text ())
1412 bass = n.get_maybe_exist_named_child ('bass')
1414 ev.bass = musicxml_chordpitch_to_lily (bass)
1415 inversion = n.get_maybe_exist_named_child ('inversion')
1417 # TODO: Lilypond does not support inversions, does it?
1419 # Mail from Carl Sorensen on lilypond-devel, June 11, 2008:
1420 # 4. LilyPond supports the first inversion in the form of added
1421 # bass notes. So the first inversion of C major would be c:/g.
1422 # To get the second inversion of C major, you would need to do
1423 # e:6-3-^5 or e:m6-^5. However, both of these techniques
1424 # require you to know the chord and calculate either the fifth
1425 # pitch (for the first inversion) or the third pitch (for the
1426 # second inversion) so they may not be helpful for musicxml2ly.
1427 inversion_count = string.atoi (inversion.get_text ())
1428 if inversion_count == 1:
1429 # TODO: Calculate the bass note for the inversion...
1432 for deg in n.get_named_children ('degree'):
1433 d = musicexp.ChordModification ()
1434 d.type = deg.get_type ()
1435 d.step = deg.get_value ()
1436 d.alteration = deg.get_alter ()
1437 ev.add_modification (d)
1438 #TODO: convert the user-symbols attribute:
1439 #major: a triangle, like Unicode 25B3
1440 #minor: -, like Unicode 002D
1441 #augmented: +, like Unicode 002B
1442 #diminished: (degree), like Unicode 00B0
1443 #half-diminished: (o with slash), like Unicode 00F8
1449 def musicxml_figured_bass_note_to_lily (n):
1450 res = musicexp.FiguredBassNote ()
1451 suffix_dict = { 'sharp' : "+",
1454 'double-sharp' : "++",
1456 'sharp-sharp' : "++",
1458 prefix = n.get_maybe_exist_named_child ('prefix')
1460 res.set_prefix (suffix_dict.get (prefix.get_text (), ""))
1461 fnumber = n.get_maybe_exist_named_child ('figure-number')
1463 res.set_number (fnumber.get_text ())
1464 suffix = n.get_maybe_exist_named_child ('suffix')
1466 res.set_suffix (suffix_dict.get (suffix.get_text (), ""))
1467 if n.get_maybe_exist_named_child ('extend'):
1468 # TODO: Implement extender lines (unfortunately, in lilypond you have
1469 # to use \set useBassFigureExtenders = ##t, which turns them on
1470 # globally, while MusicXML has a property for each note...
1471 # I'm not sure there is a proper way to implement this cleanly
1478 def musicxml_figured_bass_to_lily (n):
1479 if not isinstance (n, musicxml.FiguredBass):
1481 res = musicexp.FiguredBassEvent ()
1482 for i in n.get_named_children ('figure'):
1483 note = musicxml_figured_bass_note_to_lily (i)
1486 dur = n.get_maybe_exist_named_child ('duration')
1488 # apply the duration to res
1489 length = Rational(int(dur.get_text()), n._divisions)*Rational(1,4)
1490 res.set_real_duration (length)
1491 duration = rational_to_lily_duration (length)
1493 res.set_duration (duration)
1494 if hasattr (n, 'parentheses') and n.parentheses == "yes":
1495 res.set_parentheses (True)
1498 instrument_drumtype_dict = {
1499 'Acoustic Snare Drum': 'acousticsnare',
1500 'Side Stick': 'sidestick',
1501 'Open Triangle': 'opentriangle',
1502 'Mute Triangle': 'mutetriangle',
1503 'Tambourine': 'tambourine',
1504 'Bass Drum': 'bassdrum',
1507 def musicxml_note_to_lily_main_event (n):
1512 mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1514 pitch = musicxml_pitch_to_lily (mxl_pitch)
1515 event = musicexp.NoteEvent ()
1518 acc = n.get_maybe_exist_named_child ('accidental')
1520 # let's not force accs everywhere.
1521 event.cautionary = acc.editorial
1523 elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1524 # Unpitched elements have display-step and can also have
1526 unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1527 event = musicexp.NoteEvent ()
1528 event.pitch = musicxml_unpitched_to_lily (unpitched)
1530 elif n.get_maybe_exist_typed_child (musicxml.Rest):
1531 # rests can have display-octave and display-step, which are
1532 # treated like an ordinary note pitch
1533 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1534 event = musicexp.RestEvent ()
1535 pitch = musicxml_restdisplay_to_lily (rest)
1538 elif n.instrument_name:
1539 event = musicexp.NoteEvent ()
1540 drum_type = instrument_drumtype_dict.get (n.instrument_name)
1542 event.drum_type = drum_type
1544 n.message (_ ("drum %s type unknown, please add to instrument_drumtype_dict") % n.instrument_name)
1545 event.drum_type = 'acousticsnare'
1548 n.message (_ ("cannot find suitable event"))
1551 event.duration = musicxml_duration_to_lily (n)
1558 def __init__ (self, here, dest):
1562 class LilyPondVoiceBuilder:
1563 def __init__ (self):
1565 self.pending_dynamics = []
1566 self.end_moment = Rational (0)
1567 self.begin_moment = Rational (0)
1568 self.pending_multibar = Rational (0)
1569 self.ignore_skips = False
1570 self.has_relevant_elements = False
1571 self.measure_length = (4, 4)
1573 def _insert_multibar (self):
1574 layout_information.set_context_item ('Score', 'skipBars = ##t')
1575 r = musicexp.MultiMeasureRest ()
1576 lenfrac = Rational (self.measure_length[0], self.measure_length[1])
1577 r.duration = rational_to_lily_duration (lenfrac)
1578 r.duration.factor *= self.pending_multibar / lenfrac
1579 self.elements.append (r)
1580 self.begin_moment = self.end_moment
1581 self.end_moment = self.begin_moment + self.pending_multibar
1582 self.pending_multibar = Rational (0)
1584 def set_measure_length (self, mlen):
1585 if (mlen != self.measure_length) and self.pending_multibar:
1586 self._insert_multibar ()
1587 self.measure_length = mlen
1589 def add_multibar_rest (self, duration):
1590 self.pending_multibar += duration
1592 def set_duration (self, duration):
1593 self.end_moment = self.begin_moment + duration
1594 def current_duration (self):
1595 return self.end_moment - self.begin_moment
1597 def add_music (self, music, duration):
1598 assert isinstance (music, musicexp.Music)
1599 if self.pending_multibar > Rational (0):
1600 self._insert_multibar ()
1602 self.has_relevant_elements = True
1603 self.elements.append (music)
1604 self.begin_moment = self.end_moment
1605 self.set_duration (duration)
1607 # Insert all pending dynamics right after the note/rest:
1608 if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1609 for d in self.pending_dynamics:
1611 self.pending_dynamics = []
1613 # Insert some music command that does not affect the position in the measure
1614 def add_command (self, command):
1615 assert isinstance (command, musicexp.Music)
1616 if self.pending_multibar > Rational (0):
1617 self._insert_multibar ()
1618 self.has_relevant_elements = True
1619 self.elements.append (command)
1620 def add_barline (self, barline):
1621 # TODO: Implement merging of default barline and custom bar line
1622 self.add_music (barline, Rational (0))
1623 def add_partial (self, command):
1624 self.ignore_skips = True
1625 self.add_command (command)
1627 def add_dynamics (self, dynamic):
1628 # store the dynamic item(s) until we encounter the next note/rest:
1629 self.pending_dynamics.append (dynamic)
1631 def add_bar_check (self, number):
1632 # re/store has_relevant_elements, so that a barline alone does not
1633 # trigger output for figured bass, chord names
1634 has_relevant = self.has_relevant_elements
1635 b = musicexp.BarLine ()
1636 b.bar_number = number
1637 self.add_barline (b)
1638 self.has_relevant_elements = has_relevant
1640 def jumpto (self, moment):
1641 current_end = self.end_moment + self.pending_multibar
1642 diff = moment - current_end
1644 if diff < Rational (0):
1645 error_message (_ ('Negative skip %s (from position %s to %s)') %
1646 (diff, current_end, moment))
1649 if diff > Rational (0) and not (self.ignore_skips and moment == 0):
1650 skip = musicexp.SkipEvent()
1652 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)
1654 # TODO: Use the time signature for skips, too. Problem: The skip
1655 # might not start at a measure boundary!
1656 if duration_log > 0: # denominator is a power of 2...
1657 if diff.numerator () == 3:
1661 duration_factor = Rational (diff.numerator ())
1663 # for skips of a whole or more, simply use s1*factor
1665 duration_factor = diff
1666 skip.duration.duration_log = duration_log
1667 skip.duration.factor = duration_factor
1668 skip.duration.dots = duration_dots
1670 evc = musicexp.ChordEvent ()
1671 evc.elements.append (skip)
1672 self.add_music (evc, diff)
1674 if diff > Rational (0) and moment == 0:
1675 self.ignore_skips = False
1677 def last_event_chord (self, starting_at):
1681 # if the position matches, find the last ChordEvent, do not cross a bar line!
1682 at = len( self.elements ) - 1
1684 not isinstance (self.elements[at], musicexp.ChordEvent) and
1685 not isinstance (self.elements[at], musicexp.BarLine)):
1690 and isinstance (self.elements[at], musicexp.ChordEvent)
1691 and self.begin_moment == starting_at):
1692 value = self.elements[at]
1694 self.jumpto (starting_at)
1698 def correct_negative_skip (self, goto):
1699 self.end_moment = goto
1700 self.begin_moment = goto
1701 evc = musicexp.ChordEvent ()
1702 self.elements.append (evc)
1706 def __init__ (self):
1707 self.voicename = None
1708 self.voicedata = None
1709 self.ly_voice = None
1710 self.figured_bass = None
1711 self.chordnames = None
1712 self.lyrics_dict = {}
1713 self.lyrics_order = []
1715 def musicxml_step_to_lily (step):
1717 return (ord (step) - ord ('A') + 7 - 2) % 7
1721 def measure_length_from_attributes (attr, current_measure_length):
1722 mxl = attr.get_named_attribute ('time')
1724 return attr.get_time_signature ()
1726 return current_measure_length
1728 def musicxml_voice_to_lily_voice (voice):
1732 return_value = VoiceData ()
1733 return_value.voicedata = voice
1735 # First pitch needed for relative mode (if selected in command-line options)
1738 # Needed for melismata detection (ignore lyrics on those notes!):
1743 ignore_lyrics = False
1745 current_staff = None
1747 pending_figured_bass = []
1748 pending_chordnames = []
1750 # Make sure that the keys in the dict don't get reordered, since
1751 # we need the correct ordering of the lyrics stanzas! By default,
1752 # a dict will reorder its keys
1753 return_value.lyrics_order = voice.get_lyrics_numbers ()
1754 for k in return_value.lyrics_order:
1757 voice_builder = LilyPondVoiceBuilder ()
1758 figured_bass_builder = LilyPondVoiceBuilder ()
1759 chordnames_builder = LilyPondVoiceBuilder ()
1760 current_measure_length = (4, 4)
1761 voice_builder.set_measure_length (current_measure_length)
1763 for n in voice._elements:
1764 if n.get_name () == 'forward':
1766 staff = n.get_maybe_exist_named_child ('staff')
1768 staff = staff.get_text ()
1769 if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
1770 voice_builder.add_command (musicexp.StaffChange (staff))
1771 current_staff = staff
1773 if isinstance (n, musicxml.Partial) and n.partial > 0:
1774 a = musicxml_partial_to_lily (n.partial)
1776 voice_builder.add_partial (a)
1779 is_chord = n.get_maybe_exist_named_child ('chord')
1780 is_after_grace = (isinstance (n, musicxml.Note) and n.is_after_grace ());
1781 if not is_chord and not is_after_grace:
1783 voice_builder.jumpto (n._when)
1784 except NegativeSkip, neg:
1785 voice_builder.correct_negative_skip (n._when)
1786 n.message (_ ("Negative skip found: from %s to %s, difference is %s") % (neg.here, neg.dest, neg.dest - neg.here))
1788 if isinstance (n, musicxml.Barline):
1789 barlines = musicxml_barline_to_lily (n)
1791 if isinstance (a, musicexp.BarLine):
1792 voice_builder.add_barline (a)
1793 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
1794 voice_builder.add_command (a)
1797 # Continue any multimeasure-rests before trying to add bar checks!
1798 # Don't handle new MM rests yet, because for them we want bar checks!
1799 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1800 if (rest and rest.is_whole_measure ()
1801 and voice_builder.pending_multibar > Rational (0)):
1802 voice_builder.add_multibar_rest (n._duration)
1806 # print a bar check at the beginning of each measure!
1807 if n.is_first () and n._measure_position == Rational (0) and n != voice._elements[0]:
1809 num = int (n.get_parent ().number)
1813 voice_builder.add_bar_check (num)
1814 figured_bass_builder.add_bar_check (num)
1815 chordnames_builder.add_bar_check (num)
1817 # Start any new multimeasure rests
1818 if (rest and rest.is_whole_measure ()):
1819 voice_builder.add_multibar_rest (n._duration)
1823 if isinstance (n, musicxml.Direction):
1824 for a in musicxml_direction_to_lily (n):
1825 if a.wait_for_note ():
1826 voice_builder.add_dynamics (a)
1828 voice_builder.add_command (a)
1831 if isinstance (n, musicxml.Harmony):
1832 for a in musicxml_harmony_to_lily (n):
1833 if a.wait_for_note ():
1834 voice_builder.add_dynamics (a)
1836 voice_builder.add_command (a)
1837 for a in musicxml_harmony_to_lily_chordname (n):
1838 pending_chordnames.append (a)
1841 if isinstance (n, musicxml.FiguredBass):
1842 a = musicxml_figured_bass_to_lily (n)
1844 pending_figured_bass.append (a)
1847 if isinstance (n, musicxml.Attributes):
1848 for a in musicxml_attributes_to_lily (n):
1849 voice_builder.add_command (a)
1850 measure_length = measure_length_from_attributes (n, current_measure_length)
1851 if current_measure_length != measure_length:
1852 current_measure_length = measure_length
1853 voice_builder.set_measure_length (current_measure_length)
1856 if not n.__class__.__name__ == 'Note':
1857 n.message (_ ('unexpected %s; expected %s or %s or %s') % (n, 'Note', 'Attributes', 'Barline'))
1860 main_event = musicxml_note_to_lily_main_event (n)
1861 if main_event and not first_pitch:
1862 first_pitch = main_event.pitch
1863 # ignore lyrics for notes inside a slur, tie, chord or beam
1864 ignore_lyrics = inside_slur or is_tied or is_chord or is_beamed
1866 if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
1867 modes_found['drummode'] = True
1869 ev_chord = voice_builder.last_event_chord (n._when)
1871 ev_chord = musicexp.ChordEvent()
1872 voice_builder.add_music (ev_chord, n._duration)
1875 grace = n.get_maybe_exist_typed_child (musicxml.Grace)
1877 is_after_grace = ev_chord.has_elements () or n.is_after_grace ();
1878 is_chord = n.get_maybe_exist_typed_child (musicxml.Chord)
1882 # after-graces and other graces use different lists; Depending on
1883 # whether we have a chord or not, obtain either a new ChordEvent or
1884 # the previous one to create a chord
1886 if ev_chord.after_grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
1887 grace_chord = ev_chord.after_grace_elements.get_last_event_chord ()
1889 grace_chord = musicexp.ChordEvent ()
1890 ev_chord.append_after_grace (grace_chord)
1892 if ev_chord.grace_elements and n.get_maybe_exist_typed_child (musicxml.Chord):
1893 grace_chord = ev_chord.grace_elements.get_last_event_chord ()
1895 grace_chord = musicexp.ChordEvent ()
1896 ev_chord.append_grace (grace_chord)
1898 if hasattr (grace, 'slash') and not is_after_grace:
1899 # TODO: use grace_type = "appoggiatura" for slurred grace notes
1900 if grace.slash == "yes":
1901 ev_chord.grace_type = "acciaccatura"
1902 # now that we have inserted the chord into the grace music, insert
1903 # everything into that chord instead of the ev_chord
1904 ev_chord = grace_chord
1905 ev_chord.append (main_event)
1906 ignore_lyrics = True
1908 ev_chord.append (main_event)
1909 # When a note/chord has grace notes (duration==0), the duration of the
1910 # event chord is not yet known, but the event chord was already added
1911 # with duration 0. The following correct this when we hit the real note!
1912 if voice_builder.current_duration () == 0 and n._duration > 0:
1913 voice_builder.set_duration (n._duration)
1915 # if we have a figured bass, set its voice builder to the correct position
1916 # and insert the pending figures
1917 if pending_figured_bass:
1919 figured_bass_builder.jumpto (n._when)
1920 except NegativeSkip, neg:
1922 for fb in pending_figured_bass:
1923 # if a duration is given, use that, otherwise the one of the note
1924 dur = fb.real_duration
1926 dur = ev_chord.get_length ()
1928 fb.duration = ev_chord.get_duration ()
1929 figured_bass_builder.add_music (fb, dur)
1930 pending_figured_bass = []
1932 if pending_chordnames:
1934 chordnames_builder.jumpto (n._when)
1935 except NegativeSkip, neg:
1937 for cn in pending_chordnames:
1938 # Assign the duration of the EventChord
1939 cn.duration = ev_chord.get_duration ()
1940 chordnames_builder.add_music (cn, ev_chord.get_length ())
1941 pending_chordnames = []
1944 notations_children = n.get_typed_children (musicxml.Notations)
1948 # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
1949 # +tied | +slur | +tuplet | glissando | slide |
1950 # ornaments | technical | articulations | dynamics |
1951 # +fermata | arpeggiate | non-arpeggiate |
1952 # accidental-mark | other-notation
1953 for notations in notations_children:
1954 for tuplet_event in notations.get_tuplets():
1955 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1958 frac = mod.get_fraction ()
1960 tuplet_events.append ((ev_chord, tuplet_event, frac))
1962 # First, close all open slurs, only then start any new slur
1963 # TODO: Record the number of the open slur to dtermine the correct
1965 endslurs = [s for s in notations.get_named_children ('slur')
1966 if s.get_type () in ('stop')]
1967 if endslurs and not inside_slur:
1968 endslurs[0].message (_ ('Encountered closing slur, but no slur is open'))
1970 if len (endslurs) > 1:
1971 endslurs[0].message (_ ('Cannot have two simultaneous (closing) slurs'))
1972 # record the slur status for the next note in the loop
1975 lily_ev = musicxml_spanner_to_lily_event (endslurs[0])
1976 ev_chord.append (lily_ev)
1978 startslurs = [s for s in notations.get_named_children ('slur')
1979 if s.get_type () in ('start')]
1980 if startslurs and inside_slur:
1981 startslurs[0].message (_ ('Cannot have a slur inside another slur'))
1983 if len (startslurs) > 1:
1984 startslurs[0].message (_ ('Cannot have two simultaneous slurs'))
1985 # record the slur status for the next note in the loop
1988 lily_ev = musicxml_spanner_to_lily_event (startslurs[0])
1989 ev_chord.append (lily_ev)
1993 mxl_tie = notations.get_tie ()
1994 if mxl_tie and mxl_tie.type == 'start':
1995 ev_chord.append (musicexp.TieEvent ())
2000 fermatas = notations.get_named_children ('fermata')
2002 ev = musicxml_fermata_to_lily_event (a)
2004 ev_chord.append (ev)
2006 arpeggiate = notations.get_named_children ('arpeggiate')
2007 for a in arpeggiate:
2008 ev = musicxml_arpeggiate_to_lily_event (a)
2010 ev_chord.append (ev)
2012 arpeggiate = notations.get_named_children ('non-arpeggiate')
2013 for a in arpeggiate:
2014 ev = musicxml_nonarpeggiate_to_lily_event (a)
2016 ev_chord.append (ev)
2018 glissandos = notations.get_named_children ('glissando')
2019 glissandos += notations.get_named_children ('slide')
2020 for a in glissandos:
2021 ev = musicxml_spanner_to_lily_event (a)
2023 ev_chord.append (ev)
2025 # accidental-marks are direct children of <notation>!
2026 for a in notations.get_named_children ('accidental-mark'):
2027 ev = musicxml_articulation_to_lily_event (a)
2029 ev_chord.append (ev)
2031 # Articulations can contain the following child elements:
2032 # accent | strong-accent | staccato | tenuto |
2033 # detached-legato | staccatissimo | spiccato |
2034 # scoop | plop | doit | falloff | breath-mark |
2035 # caesura | stress | unstress
2036 # Technical can contain the following child elements:
2037 # up-bow | down-bow | harmonic | open-string |
2038 # thumb-position | fingering | pluck | double-tongue |
2039 # triple-tongue | stopped | snap-pizzicato | fret |
2040 # string | hammer-on | pull-off | bend | tap | heel |
2041 # toe | fingernails | other-technical
2042 # Ornaments can contain the following child elements:
2043 # trill-mark | turn | delayed-turn | inverted-turn |
2044 # shake | wavy-line | mordent | inverted-mordent |
2045 # schleifer | tremolo | other-ornament, accidental-mark
2046 ornaments = notations.get_named_children ('ornaments')
2047 ornaments += notations.get_named_children ('articulations')
2048 ornaments += notations.get_named_children ('technical')
2051 for ch in a.get_all_children ():
2052 ev = musicxml_articulation_to_lily_event (ch)
2054 ev_chord.append (ev)
2056 dynamics = notations.get_named_children ('dynamics')
2058 for ch in a.get_all_children ():
2059 ev = musicxml_dynamics_to_lily_event (ch)
2061 ev_chord.append (ev)
2064 mxl_beams = [b for b in n.get_named_children ('beam')
2065 if (b.get_type () in ('begin', 'end')
2066 and b.is_primary ())]
2067 if mxl_beams and not conversion_settings.ignore_beaming:
2068 beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
2070 ev_chord.append (beam_ev)
2071 if beam_ev.span_direction == -1: # beam and thus melisma starts here
2073 elif beam_ev.span_direction == 1: # beam and thus melisma ends here
2077 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
2080 frac = mod.get_fraction ()
2082 tuplet_events.append ((ev_chord, tuplet_event, frac))
2084 # Extract the lyrics
2085 if not rest and not ignore_lyrics:
2086 note_lyrics_processed = []
2087 note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
2088 for l in note_lyrics_elements:
2089 if l.get_number () < 0:
2090 for k in lyrics.keys ():
2091 lyrics[k].append (l.lyric_to_text ())
2092 note_lyrics_processed.append (k)
2094 lyrics[l.number].append(l.lyric_to_text ())
2095 note_lyrics_processed.append (l.number)
2096 for lnr in lyrics.keys ():
2097 if not lnr in note_lyrics_processed:
2098 lyrics[lnr].append ("\skip4")
2100 ## force trailing mm rests to be written out.
2101 voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
2103 ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
2104 ly_voice = group_repeats (ly_voice)
2106 seq_music = musicexp.SequentialMusic ()
2108 if 'drummode' in modes_found.keys ():
2109 ## \key <pitch> barfs in drummode.
2110 ly_voice = [e for e in ly_voice
2111 if not isinstance(e, musicexp.KeySignatureChange)]
2113 seq_music.elements = ly_voice
2114 for k in lyrics.keys ():
2115 return_value.lyrics_dict[k] = musicexp.Lyrics ()
2116 return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
2119 if len (modes_found) > 1:
2120 error_message (_ ('cannot simultaneously have more than one mode: %s') % modes_found.keys ())
2122 if options.relative:
2123 v = musicexp.RelativeMusic ()
2124 v.element = seq_music
2125 v.basepitch = first_pitch
2128 return_value.ly_voice = seq_music
2129 for mode in modes_found.keys ():
2130 v = musicexp.ModeChangingMusicWrapper()
2131 v.element = seq_music
2133 return_value.ly_voice = v
2135 # create \figuremode { figured bass elements }
2136 if figured_bass_builder.has_relevant_elements:
2137 fbass_music = musicexp.SequentialMusic ()
2138 fbass_music.elements = figured_bass_builder.elements
2139 v = musicexp.ModeChangingMusicWrapper()
2140 v.mode = 'figuremode'
2141 v.element = fbass_music
2142 return_value.figured_bass = v
2144 # create \chordmode { chords }
2145 if chordnames_builder.has_relevant_elements:
2146 cname_music = musicexp.SequentialMusic ()
2147 cname_music.elements = chordnames_builder.elements
2148 v = musicexp.ModeChangingMusicWrapper()
2149 v.mode = 'chordmode'
2150 v.element = cname_music
2151 return_value.chordnames = v
2155 def musicxml_id_to_lily (id):
2156 digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
2157 'Six', 'Seven', 'Eight', 'Nine', 'Ten']
2159 for digit in digits:
2160 d = digits.index (digit)
2161 id = re.sub ('%d' % d, digit, id)
2163 id = re.sub ('[^a-zA-Z]', 'X', id)
2166 def musicxml_pitch_to_lily (mxl_pitch):
2167 p = musicexp.Pitch ()
2168 p.alteration = mxl_pitch.get_alteration ()
2169 p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
2170 p.octave = mxl_pitch.get_octave () - 4
2173 def musicxml_unpitched_to_lily (mxl_unpitched):
2175 step = mxl_unpitched.get_step ()
2177 p = musicexp.Pitch ()
2178 p.step = musicxml_step_to_lily (step)
2179 octave = mxl_unpitched.get_octave ()
2181 p.octave = octave - 4
2184 def musicxml_restdisplay_to_lily (mxl_rest):
2186 step = mxl_rest.get_step ()
2188 p = musicexp.Pitch ()
2189 p.step = musicxml_step_to_lily (step)
2190 octave = mxl_rest.get_octave ()
2192 p.octave = octave - 4
2195 def voices_in_part (part):
2196 """Return a Name -> Voice dictionary for PART"""
2198 part.extract_voices ()
2199 voices = part.get_voices ()
2200 part_info = part.get_staff_attributes ()
2202 return (voices, part_info)
2204 def voices_in_part_in_parts (parts):
2205 """return a Part -> Name -> Voice dictionary"""
2206 return dict([(p.id, voices_in_part (p)) for p in parts])
2209 def get_all_voices (parts):
2210 all_voices = voices_in_part_in_parts (parts)
2213 all_ly_staffinfo = {}
2214 for p, (name_voice, staff_info) in all_voices.items ():
2217 for n, v in name_voice.items ():
2218 progress (_ ("Converting to LilyPond expressions..."))
2219 # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
2220 part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
2222 all_ly_voices[p] = part_ly_voices
2223 all_ly_staffinfo[p] = staff_info
2225 return (all_ly_voices, all_ly_staffinfo)
2228 def option_parser ():
2229 p = ly.get_option_parser (usage = _ ("musicxml2ly [OPTION]... FILE.xml"),
2231 _ ("""Convert MusicXML from FILE.xml to LilyPond input.
2232 If the given filename is -, musicxml2ly reads from the command line.
2233 """), add_help_option=False)
2235 p.add_option("-h", "--help",
2237 help=_ ("show this help and exit"))
2239 p.version = ('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
2241 _ ("""Copyright (c) 2005--2008 by
2242 Han-Wen Nienhuys <hanwen@xs4all.nl>,
2243 Jan Nieuwenhuizen <janneke@gnu.org> and
2244 Reinhold Kainhofer <reinhold@kainhofer.com>
2248 This program is free software. It is covered by the GNU General Public
2249 License and you are welcome to change it and/or distribute copies of it
2250 under certain conditions. Invoke as `%s --warranty' for more
2251 information.""") % 'lilypond')
2253 p.add_option("--version",
2255 help=_ ("show version number and exit"))
2257 p.add_option ('-v', '--verbose',
2258 action = "store_true",
2260 help = _ ("be verbose"))
2262 p.add_option ('', '--lxml',
2263 action = "store_true",
2266 help = _ ("use lxml.etree; uses less memory and cpu time"))
2268 p.add_option ('-z', '--compressed',
2269 action = "store_true",
2270 dest = 'compressed',
2272 help = _ ("input file is a zip-compressed MusicXML file"))
2274 p.add_option ('-r', '--relative',
2275 action = "store_true",
2278 help = _ ("convert pitches in relative mode (default)"))
2280 p.add_option ('-a', '--absolute',
2281 action = "store_false",
2283 help = _ ("convert pitches in absolute mode"))
2285 p.add_option ('-l', '--language',
2286 metavar = _ ("LANG"),
2288 help = _ ("use a different language file 'LANG.ly' and corresponding pitch names, e.g. 'deutsch' for deutsch.ly"))
2290 p.add_option ('--nd', '--no-articulation-directions',
2291 action = "store_false",
2293 dest = "convert_directions",
2294 help = _ ("do not convert directions (^, _ or -) for articulations, dynamics, etc."))
2296 p.add_option ('--no-beaming',
2297 action = "store_false",
2299 dest = "convert_beaming",
2300 help = _ ("do not convert beaming information, use lilypond's automatic beaming instead"))
2302 p.add_option ('-o', '--output',
2303 metavar = _ ("FILE"),
2307 dest = 'output_name',
2308 help = _ ("set output filename to FILE, stdout if -"))
2309 p.add_option_group ('',
2310 description = (_ ("Report bugs via")
2311 + ''' http://post.gmane.org/post.php'''
2312 '''?group=gmane.comp.gnu.lilypond.bugs\n'''))
2315 def music_xml_voice_name_to_lily_name (part_id, name):
2316 str = "Part%sVoice%s" % (part_id, name)
2317 return musicxml_id_to_lily (str)
2319 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
2320 str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
2321 return musicxml_id_to_lily (str)
2323 def music_xml_figuredbass_name_to_lily_name (part_id, voicename):
2324 str = "Part%sVoice%sFiguredBass" % (part_id, voicename)
2325 return musicxml_id_to_lily (str)
2327 def music_xml_chordnames_name_to_lily_name (part_id, voicename):
2328 str = "Part%sVoice%sChords" % (part_id, voicename)
2329 return musicxml_id_to_lily (str)
2331 def print_voice_definitions (printer, part_list, voices):
2332 for part in part_list:
2334 nv_dict = voices.get (part_id, {})
2335 for (name, voice) in nv_dict.items ():
2336 k = music_xml_voice_name_to_lily_name (part_id, name)
2337 printer.dump ('%s = ' % k)
2338 voice.ly_voice.print_ly (printer)
2340 if voice.chordnames:
2341 cnname = music_xml_chordnames_name_to_lily_name (part_id, name)
2342 printer.dump ('%s = ' % cnname )
2343 voice.chordnames.print_ly (printer)
2345 for l in voice.lyrics_order:
2346 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
2347 printer.dump ('%s = ' % lname )
2348 voice.lyrics_dict[l].print_ly (printer)
2350 if voice.figured_bass:
2351 fbname = music_xml_figuredbass_name_to_lily_name (part_id, name)
2352 printer.dump ('%s = ' % fbname )
2353 voice.figured_bass.print_ly (printer)
2358 return dict ([(elt,1) for elt in l]).keys ()
2360 # format the information about the staff in the form
2363 # [voiceid1, [lyricsid11, lyricsid12,...], figuredbassid1],
2364 # [voiceid2, [lyricsid21, lyricsid22,...], figuredbassid2],
2368 # raw_voices is of the form [(voicename, lyricsids, havefiguredbass)*]
2369 def format_staff_info (part_id, staff_id, raw_voices):
2371 for (v, lyricsids, figured_bass, chordnames) in raw_voices:
2372 voice_name = music_xml_voice_name_to_lily_name (part_id, v)
2373 voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
2375 figured_bass_name = ''
2377 figured_bass_name = music_xml_figuredbass_name_to_lily_name (part_id, v)
2378 chordnames_name = ''
2380 chordnames_name = music_xml_chordnames_name_to_lily_name (part_id, v)
2381 voices.append ([voice_name, voice_lyrics, figured_bass_name, chordnames_name])
2382 return [staff_id, voices]
2384 def update_score_setup (score_structure, part_list, voices):
2386 for part_definition in part_list:
2387 part_id = part_definition.id
2388 nv_dict = voices.get (part_id)
2390 error_message (_ ('unknown part in part-list: %s') % part_id)
2393 staves = reduce (lambda x,y: x+ y,
2394 [voice.voicedata._staves.keys ()
2395 for voice in nv_dict.values ()],
2398 if len (staves) > 1:
2400 staves = uniq_list (staves)
2403 thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2404 for (voice_name, voice) in nv_dict.items ()
2405 if voice.voicedata._start_staff == s]
2406 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
2408 thisstaff_raw_voices = [(voice_name, voice.lyrics_order, voice.figured_bass, voice.chordnames)
2409 for (voice_name, voice) in nv_dict.items ()]
2410 staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
2411 score_structure.set_part_information (part_id, staves_info)
2413 # Set global values in the \layout block, like auto-beaming etc.
2414 def update_layout_information ():
2415 if not conversion_settings.ignore_beaming and layout_information:
2416 layout_information.set_context_item ('Score', 'autoBeaming = ##f')
2418 def print_ly_preamble (printer, filename):
2419 printer.dump_version ()
2420 printer.print_verbatim ('%% automatically converted from %s\n' % filename)
2422 def print_ly_additional_definitions (printer, filename):
2423 if needed_additional_definitions:
2425 printer.print_verbatim ('%% additional definitions required by the score:')
2427 for a in set(needed_additional_definitions):
2428 printer.print_verbatim (additional_definitions.get (a, ''))
2432 # Read in the tree from the given I/O object (either file or string) and
2433 # demarshall it using the classes from the musicxml.py file
2434 def read_xml (io_object, use_lxml):
2437 tree = lxml.etree.parse (io_object)
2438 mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
2441 from xml.dom import minidom, Node
2442 doc = minidom.parse(io_object)
2443 node = doc.documentElement
2444 return musicxml.minidom_demarshal_node (node)
2448 def read_musicxml (filename, compressed, use_lxml):
2452 progress (_ ("Input is compressed, extracting raw MusicXML data from stdin") )
2453 z = zipfile.ZipFile (sys.stdin)
2455 progress (_ ("Input file %s is compressed, extracting raw MusicXML data") % filename)
2456 z = zipfile.ZipFile (filename, "r")
2457 container_xml = z.read ("META-INF/container.xml")
2458 if not container_xml:
2460 container = read_xml (StringIO.StringIO (container_xml), use_lxml)
2463 rootfiles = container.get_maybe_exist_named_child ('rootfiles')
2466 rootfile_list = rootfiles.get_named_children ('rootfile')
2468 if len (rootfile_list) > 0:
2469 mxml_file = getattr (rootfile_list[0], 'full-path', None)
2471 raw_string = z.read (mxml_file)
2474 io_object = StringIO.StringIO (raw_string)
2475 elif filename == "-":
2476 io_object = sys.stdin
2478 io_object = filename
2480 return read_xml (io_object, use_lxml)
2483 def convert (filename, options):
2485 progress (_ ("Reading MusicXML from Standard input ...") )
2487 progress (_ ("Reading MusicXML from %s ...") % filename)
2489 tree = read_musicxml (filename, options.compressed, options.use_lxml)
2490 score_information = extract_score_information (tree)
2491 paper_information = extract_paper_information (tree)
2493 parts = tree.get_typed_children (musicxml.Part)
2494 (voices, staff_info) = get_all_voices (parts)
2497 mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
2499 score = extract_score_structure (mxl_pl, staff_info)
2500 part_list = mxl_pl.get_named_children ("score-part")
2502 # score information is contained in the <work>, <identification> or <movement-title> tags
2503 update_score_setup (score, part_list, voices)
2504 # After the conversion, update the list of settings for the \layout block
2505 update_layout_information ()
2507 if not options.output_name:
2508 options.output_name = os.path.basename (filename)
2509 options.output_name = os.path.splitext (options.output_name)[0]
2510 elif re.match (".*\.ly", options.output_name):
2511 options.output_name = os.path.splitext (options.output_name)[0]
2514 #defs_ly_name = options.output_name + '-defs.ly'
2515 if (options.output_name == "-"):
2516 output_ly_name = 'Standard output'
2518 output_ly_name = options.output_name + '.ly'
2520 progress (_ ("Output to `%s'") % output_ly_name)
2521 printer = musicexp.Output_printer()
2522 #progress (_ ("Output to `%s'") % defs_ly_name)
2523 if (options.output_name == "-"):
2524 printer.set_file (codecs.getwriter ("utf-8")(sys.stdout))
2526 printer.set_file (codecs.open (output_ly_name, 'wb', encoding='utf-8'))
2527 print_ly_preamble (printer, filename)
2528 print_ly_additional_definitions (printer, filename)
2529 if score_information:
2530 score_information.print_ly (printer)
2531 if paper_information:
2532 paper_information.print_ly (printer)
2533 if layout_information:
2534 layout_information.print_ly (printer)
2535 print_voice_definitions (printer, part_list, voices)
2538 printer.dump ("% The score definition")
2540 score.print_ly (printer)
2545 def get_existing_filename_with_extension (filename, ext):
2546 if os.path.exists (filename):
2548 newfilename = filename + "." + ext
2549 if os.path.exists (newfilename):
2551 newfilename = filename + ext
2552 if os.path.exists (newfilename):
2557 opt_parser = option_parser()
2560 (options, args) = opt_parser.parse_args ()
2562 opt_parser.print_usage()
2565 if options.language:
2566 musicexp.set_pitch_language (options.language)
2567 needed_additional_definitions.append (options.language)
2568 additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
2569 conversion_settings.ignore_beaming = not options.convert_beaming
2571 # Allow the user to leave out the .xml or xml on the filename
2572 basefilename = args[0].decode('utf-8')
2573 if basefilename == "-": # Read from stdin
2576 filename = get_existing_filename_with_extension (basefilename, "xml")
2578 filename = get_existing_filename_with_extension (basefilename, "mxl")
2579 options.compressed = True
2580 if filename and filename.endswith ("mxl"):
2581 options.compressed = True
2583 if filename and (filename == "-" or os.path.exists (filename)):
2584 voices = convert (filename, options)
2586 progress (_ ("Unable to find input file %s") % basefilename)
2588 if __name__ == '__main__':