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)
65 def round_to_two_digits (val):
66 return round (val * 100) / 100
68 def extract_paper_information (tree):
69 paper = musicexp.Paper ()
70 defaults = tree.get_maybe_exist_named_child ('defaults')
74 scaling = defaults.get_maybe_exist_named_child ('scaling')
76 mm = scaling.get_named_child ('millimeters')
77 mm = string.atof (mm.get_text ())
78 tn = scaling.get_maybe_exist_named_child ('tenths')
79 tn = string.atof (tn.get_text ())
81 paper.global_staff_size = mm * 72.27 / 25.4
82 # We need the scaling (i.e. the size of staff tenths for everything!
86 def from_tenths (txt):
87 return round_to_two_digits (string.atof (txt) * tenths / 10)
88 def set_paper_variable (varname, parent, element_name):
89 el = parent.get_maybe_exist_named_child (element_name)
90 if el: # Convert to cm from tenths
91 setattr (paper, varname, from_tenths (el.get_text ()))
93 pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
95 # TODO: How can one have different margins for even and odd pages???
96 set_paper_variable ("page_height", pagelayout, 'page-height')
97 set_paper_variable ("page_width", pagelayout, 'page-width')
99 pmargins = pagelayout.get_named_children ('page-margins')
101 set_paper_variable ("left_margin", pm, 'left-margin')
102 set_paper_variable ("right_margin", pm, 'right-margin')
103 set_paper_variable ("bottom_margin", pm, 'bottom-margin')
104 set_paper_variable ("top_margin", pm, 'top-margin')
106 systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
108 sl = systemlayout.get_maybe_exist_named_child ('system-margins')
110 set_paper_variable ("system_left_margin", sl, 'left-margin')
111 set_paper_variable ("system_right_margin", sl, 'right-margin')
112 set_paper_variable ("system_distance", systemlayout, 'system-distance')
113 set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
115 stafflayout = defaults.get_named_children ('staff-layout')
116 for sl in stafflayout:
117 nr = getattr (sl, 'number', 1)
118 dist = sl.get_named_child ('staff-distance')
119 #TODO: the staff distance needs to be set in the Staff context!!!
121 # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
122 appearance = defaults.get_named_child ('appearance')
124 lws = appearance.get_named_children ('line-width')
126 # Possible types are: beam, bracket, dashes,
127 # enclosure, ending, extend, heavy barline, leger,
128 # light barline, octave shift, pedal, slur middle, slur tip,
129 # staff, stem, tie middle, tie tip, tuplet bracket, and wedge
131 w = from_tenths (lw.get_text ())
132 # TODO: Do something with these values!
133 nss = appearance.get_named_children ('note-size')
135 # Possible types are: cue, grace and large
137 sz = from_tenths (ns.get_text ())
138 # TODO: Do something with these values!
139 # <other-appearance> elements have no specified meaning
141 rawmusicfont = defaults.get_named_child ('music-font')
143 # TODO: Convert the font
145 rawwordfont = defaults.get_named_child ('word-font')
147 # TODO: Convert the font
149 rawlyricsfonts = defaults.get_named_children ('lyric-font')
150 for lyricsfont in rawlyricsfonts:
151 # TODO: Convert the font
158 # score information is contained in the <work>, <identification> or <movement-title> tags
159 # extract those into a hash, indexed by proper lilypond header attributes
160 def extract_score_information (tree):
161 header = musicexp.Header ()
162 def set_if_exists (field, value):
164 header.set_field (field, musicxml.escape_ly_output_string (value))
166 work = tree.get_maybe_exist_named_child ('work')
168 set_if_exists ('title', work.get_work_title ())
169 set_if_exists ('worknumber', work.get_work_number ())
170 set_if_exists ('opus', work.get_opus ())
172 movement_title = tree.get_maybe_exist_named_child ('movement-title')
174 set_if_exists ('title', movement_title.get_text ())
176 identifications = tree.get_named_children ('identification')
177 for ids in identifications:
178 set_if_exists ('copyright', ids.get_rights ())
179 set_if_exists ('composer', ids.get_composer ())
180 set_if_exists ('arranger', ids.get_arranger ())
181 set_if_exists ('editor', ids.get_editor ())
182 set_if_exists ('poet', ids.get_poet ())
184 set_if_exists ('tagline', ids.get_encoding_software ())
185 set_if_exists ('encodingsoftware', ids.get_encoding_software ())
186 set_if_exists ('encodingdate', ids.get_encoding_date ())
187 set_if_exists ('encoder', ids.get_encoding_person ())
188 set_if_exists ('encodingdescription', ids.get_encoding_description ())
190 # Finally, apply the required compatibility modes
191 # Some applications created wrong MusicXML files, so we need to
192 # apply some compatibility mode, e.g. ignoring some features/tags
194 software = ids.get_encoding_software_list ()
196 # Case 1: "Sibelius 5.1" with the "Dolet 3.4 for Sibelius" plugin
197 # is missing all beam ends => ignore all beaming information
198 if "Dolet 3.4 for Sibelius" in software:
199 conversion_settings.ignore_beaming = True
200 progress (_ ("Encountered file created by Dolet 3.4 for Sibelius, containing wrong beaming information. All beaming information in the MusicXML file will be ignored"))
201 # TODO: Check for other unsupported features
210 return len (self.start) + len (self.end) == 0
211 def add_start (self, g):
212 self.start[getattr (g, 'number', "1")] = g
213 def add_end (self, g):
214 self.end[getattr (g, 'number', "1")] = g
215 def print_ly (self, printer):
216 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
217 def ly_expression (self):
218 error_message (_ ("Unprocessed PartGroupInfo %s encountered") % self)
221 def staff_attributes_to_string_tunings (mxl_attr):
222 details = mxl_attr.get_maybe_exist_named_child ('staff-details')
226 staff_lines = details.get_maybe_exist_named_child ('staff-lines')
228 lines = string.atoi (staff_lines.get_text ())
231 staff_tunings = details.get_named_children ('staff-tuning')
232 for i in staff_tunings:
236 line = string.atoi (i.line) - 1
241 step = i.get_named_child (u'tuning-step')
242 step = step.get_text ().strip ()
243 p.step = musicxml_step_to_lily (step)
245 octave = i.get_named_child (u'tuning-octave')
246 octave = octave.get_text ().strip ()
247 p.octave = int (octave) - 4
249 alter = i.get_named_child (u'tuning-alter')
251 p.alteration = int (alter.get_text ().strip ())
252 # lilypond seems to use the opposite ordering than MusicXML...
258 def staff_attributes_to_lily_staff (mxl_attr):
260 return musicexp.Staff ()
262 (staff_id, attributes) = mxl_attr.items ()[0]
264 # distinguish by clef:
265 # percussion (percussion and rhythmic), tab, and everything else
267 clef = attributes.get_maybe_exist_named_child ('clef')
269 sign = clef.get_maybe_exist_named_child ('sign')
271 clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
274 details = attributes.get_named_children ('staff-details')
276 staff_lines = d.get_maybe_exist_named_child ('staff-lines')
278 lines = string.atoi (staff_lines.get_text ())
281 if clef_sign == "percussion" and lines == 1:
282 staff = musicexp.RhythmicStaff ()
283 elif clef_sign == "percussion":
284 staff = musicexp.DrumStaff ()
285 # staff.drum_style_table = ???
286 elif clef_sign == "tab":
287 staff = musicexp.TabStaff ()
288 staff.string_tunings = staff_attributes_to_string_tunings (attributes)
289 # staff.tablature_format = ???
291 # TODO: Handle case with lines <> 5!
292 staff = musicexp.Staff ()
297 def extract_score_structure (part_list, staffinfo):
298 structure = musicexp.StaffGroup (None)
302 def read_score_part (el):
303 if not isinstance (el, musicxml.Score_part):
305 # Depending on the attributes of the first measure, we create different
306 # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
307 staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
311 partname = el.get_maybe_exist_named_child ('part-name')
312 # Finale gives unnamed parts the name "MusicXML Part" automatically!
313 if partname and partname.get_text() != "MusicXML Part":
314 staff.instrument_name = partname.get_text ()
315 if el.get_maybe_exist_named_child ('part-abbreviation'):
316 staff.short_instrument_name = el.get_maybe_exist_named_child ('part-abbreviation').get_text ()
317 # TODO: Read in the MIDI device / instrument
320 def read_score_group (el):
321 if not isinstance (el, musicxml.Part_group):
323 group = musicexp.StaffGroup ()
324 if hasattr (el, 'number'):
327 #currentgroups_dict[id] = group
328 #currentgroups.append (id)
329 if el.get_maybe_exist_named_child ('group-name'):
330 group.instrument_name = el.get_maybe_exist_named_child ('group-name').get_text ()
331 if el.get_maybe_exist_named_child ('group-abbreviation'):
332 group.short_instrument_name = el.get_maybe_exist_named_child ('group-abbreviation').get_text ()
333 if el.get_maybe_exist_named_child ('group-symbol'):
334 group.symbol = el.get_maybe_exist_named_child ('group-symbol').get_text ()
335 if el.get_maybe_exist_named_child ('group-barline'):
336 group.spanbar = el.get_maybe_exist_named_child ('group-barline').get_text ()
340 parts_groups = part_list.get_all_children ()
342 # the start/end group tags are not necessarily ordered correctly and groups
343 # might even overlap, so we can't go through the children sequentially!
345 # 1) Replace all Score_part objects by their corresponding Staff objects,
346 # also collect all group start/stop points into one PartGroupInfo object
348 group_info = PartGroupInfo ()
349 for el in parts_groups:
350 if isinstance (el, musicxml.Score_part):
351 if not group_info.is_empty ():
352 staves.append (group_info)
353 group_info = PartGroupInfo ()
354 staff = read_score_part (el)
356 staves.append (staff)
357 elif isinstance (el, musicxml.Part_group):
358 if el.type == "start":
359 group_info.add_start (el)
360 elif el.type == "stop":
361 group_info.add_end (el)
362 if not group_info.is_empty ():
363 staves.append (group_info)
365 # 2) Now, detect the groups:
368 while pos < len (staves):
370 if isinstance (el, PartGroupInfo):
372 if len (group_starts) > 0:
373 prev_start = group_starts[-1]
374 elif len (el.end) > 0: # no group to end here
376 if len (el.end) > 0: # closes an existing group
377 ends = el.end.keys ()
378 prev_started = staves[prev_start].start.keys ()
380 intersection = filter(lambda x:x in ends, prev_started)
381 if len (intersection) > 0:
382 grpid = intersection[0]
384 # Close the last started group
385 grpid = staves[prev_start].start.keys () [0]
386 # Find the corresponding closing tag and remove it!
389 while j < len (staves) and not foundclosing:
390 if isinstance (staves[j], PartGroupInfo) and staves[j].end.has_key (grpid):
392 del staves[j].end[grpid]
393 if staves[j].is_empty ():
396 grpobj = staves[prev_start].start[grpid]
397 group = read_score_group (grpobj)
398 # remove the id from both the start and end
399 if el.end.has_key (grpid):
401 del staves[prev_start].start[grpid]
404 # replace the staves with the whole group
405 for j in staves[(prev_start + 1):pos]:
407 j.stafftype = "InnerStaffGroup"
408 group.append_staff (j)
409 del staves[(prev_start + 1):pos]
410 staves.insert (prev_start + 1, group)
411 # reset pos so that we continue at the correct position
413 # remove an empty start group
414 if staves[prev_start].is_empty ():
415 del staves[prev_start]
416 group_starts.remove (prev_start)
418 elif len (el.start) > 0: # starts new part groups
419 group_starts.append (pos)
422 if len (staves) == 1:
425 structure.append_staff (i)
430 def musicxml_duration_to_lily (mxl_note):
431 d = musicexp.Duration ()
432 # if the note has no Type child, then that method spits out a warning and
433 # returns 0, i.e. a whole note
434 d.duration_log = mxl_note.get_duration_log ()
436 d.dots = len (mxl_note.get_typed_children (musicxml.Dot))
437 # Grace notes by specification have duration 0, so no time modification
438 # factor is possible. It even messes up the output with *0/1
439 if not mxl_note.get_maybe_exist_typed_child (musicxml.Grace):
440 d.factor = mxl_note._duration / d.get_length ()
444 def rational_to_lily_duration (rational_len):
445 d = musicexp.Duration ()
446 d.duration_log = {1: 0, 2: 1, 4:2, 8:3, 16:4, 32:5, 64:6, 128:7, 256:8, 512:9}.get (rational_len.denominator (), -1)
447 d.factor = Rational (rational_len.numerator ())
448 if d.duration_log < 0:
449 error_message (_ ("Encountered rational duration with denominator %s, "
450 "unable to convert to lilypond duration") %
451 rational_len.denominator ())
452 # TODO: Test the above error message
457 def musicxml_partial_to_lily (partial_len):
459 p = musicexp.Partial ()
460 p.partial = rational_to_lily_duration (partial_len)
465 # Detect repeats and alternative endings in the chord event list (music_list)
466 # and convert them to the corresponding musicexp objects, containing nested
468 def group_repeats (music_list):
469 repeat_replaced = True
472 # Walk through the list of expressions, looking for repeat structure
473 # (repeat start/end, corresponding endings). If we find one, try to find the
474 # last event of the repeat, replace the whole structure and start over again.
475 # For nested repeats, as soon as we encounter another starting repeat bar,
476 # treat that one first, and start over for the outer repeat.
477 while repeat_replaced and i < 100:
479 repeat_start = -1 # position of repeat start / end
480 repeat_end = -1 # position of repeat start / end
482 ending_start = -1 # position of current ending start
483 endings = [] # list of already finished endings
485 last = len (music_list) - 1
486 repeat_replaced = False
488 while pos < len (music_list) and not repeat_replaced:
490 repeat_finished = False
491 if isinstance (e, RepeatMarker):
492 if not repeat_times and e.times:
493 repeat_times = e.times
494 if e.direction == -1:
496 repeat_finished = True
502 elif e.direction == 1:
508 elif isinstance (e, EndingMarker):
509 if e.direction == -1:
515 elif e.direction == 1:
518 endings.append ([ending_start, pos])
521 elif not isinstance (e, musicexp.BarLine):
522 # As soon as we encounter an element when repeat start and end
523 # is set and we are not inside an alternative ending,
524 # this whole repeat structure is finished => replace it
525 if repeat_start >= 0 and repeat_end > 0 and ending_start < 0:
526 repeat_finished = True
528 # Finish off all repeats without explicit ending bar (e.g. when
529 # we convert only one page of a multi-page score with repeats)
530 if pos == last and repeat_start >= 0:
531 repeat_finished = True
535 if ending_start >= 0:
536 endings.append ([ending_start, pos])
540 # We found the whole structure replace it!
541 r = musicexp.RepeatedMusic ()
542 if repeat_times <= 0:
544 r.repeat_count = repeat_times
545 # don't erase the first element for "implicit" repeats (i.e. no
546 # starting repeat bars at the very beginning)
547 start = repeat_start+1
548 if repeat_start == music_start:
550 r.set_music (music_list[start:repeat_end])
551 for (start, end) in endings:
552 s = musicexp.SequentialMusic ()
553 s.elements = music_list[start+1:end]
555 del music_list[repeat_start:final_marker+1]
556 music_list.insert (repeat_start, r)
557 repeat_replaced = True
559 # TODO: Implement repeats until the end without explicit ending bar
564 def group_tuplets (music_list, events):
567 """Collect Musics from
568 MUSIC_LIST demarcated by EVENTS_LIST in TimeScaledMusic objects.
575 for (ev_chord, tuplet_elt, fraction) in events:
576 while (j < len (music_list)):
577 if music_list[j] == ev_chord:
580 if tuplet_elt.type == 'start':
581 indices.append ((j, None, fraction))
582 elif tuplet_elt.type == 'stop':
583 indices[-1] = (indices[-1][0], j, indices[-1][2])
587 for (i1, i2, frac) in indices:
591 new_list.extend (music_list[last:i1])
592 seq = musicexp.SequentialMusic ()
594 seq.elements = music_list[i1:last]
596 tsm = musicexp.TimeScaledMusic ()
599 tsm.numerator = frac[0]
600 tsm.denominator = frac[1]
602 new_list.append (tsm)
604 new_list.extend (music_list[last:])
608 def musicxml_clef_to_lily (attributes):
609 change = musicexp.ClefChange ()
610 (change.type, change.position, change.octave) = attributes.get_clef_information ()
613 def musicxml_time_to_lily (attributes):
614 (beats, type) = attributes.get_time_signature ()
616 change = musicexp.TimeSignatureChange()
617 change.fraction = (beats, type)
621 def musicxml_key_to_lily (attributes):
622 start_pitch = musicexp.Pitch ()
623 (fifths, mode) = attributes.get_key_signature ()
630 start_pitch.alteration = a
632 error_message (_ ("unknown mode %s, expecting 'major' or 'minor'") % mode)
634 fifth = musicexp.Pitch()
641 for x in range (fifths):
642 start_pitch = start_pitch.transposed (fifth)
644 start_pitch.octave = 0
646 change = musicexp.KeySignatureChange()
648 change.tonic = start_pitch
651 def musicxml_attributes_to_lily (attrs):
654 'clef': musicxml_clef_to_lily,
655 'time': musicxml_time_to_lily,
656 'key': musicxml_key_to_lily
658 for (k, func) in attr_dispatch.items ():
659 children = attrs.get_named_children (k)
661 elts.append (func (attrs))
665 class Marker (musicexp.Music):
669 def print_ly (self, printer):
670 ly.stderr_write (_ ("Encountered unprocessed marker %s\n") % self)
672 def ly_expression (self):
674 class RepeatMarker (Marker):
676 Marker.__init__ (self)
678 class EndingMarker (Marker):
681 # Convert the <barline> element to musicxml.BarLine (for non-standard barlines)
682 # and to RepeatMarker and EndingMarker objects for repeat and
683 # alternatives start/stops
684 def musicxml_barline_to_lily (barline):
685 # retval contains all possible markers in the order:
686 # 0..bw_ending, 1..bw_repeat, 2..barline, 3..fw_repeat, 4..fw_ending
688 bartype_element = barline.get_maybe_exist_named_child ("bar-style")
689 repeat_element = barline.get_maybe_exist_named_child ("repeat")
690 ending_element = barline.get_maybe_exist_named_child ("ending")
694 bartype = bartype_element.get_text ()
696 if repeat_element and hasattr (repeat_element, 'direction'):
697 repeat = RepeatMarker ()
698 repeat.direction = {"forward": -1, "backward": 1}.get (repeat_element.direction, 0)
700 if ( (repeat_element.direction == "forward" and bartype == "heavy-light") or
701 (repeat_element.direction == "backward" and bartype == "light-heavy") ):
703 if hasattr (repeat_element, 'times'):
705 repeat.times = int (repeat_element.times)
708 repeat.event = barline
709 if repeat.direction == -1:
714 if ending_element and hasattr (ending_element, 'type'):
715 ending = EndingMarker ()
716 ending.direction = {"start": -1, "stop": 1, "discontinue": 1}.get (ending_element.type, 0)
717 ending.event = barline
718 if ending.direction == -1:
724 b = musicexp.BarLine ()
728 return retval.values ()
730 spanner_event_dict = {
731 'beam' : musicexp.BeamEvent,
732 'dashes' : musicexp.TextSpannerEvent,
733 'bracket' : musicexp.BracketSpannerEvent,
734 'glissando' : musicexp.GlissandoEvent,
735 'octave-shift' : musicexp.OctaveShiftEvent,
736 'pedal' : musicexp.PedalEvent,
737 'slide' : musicexp.GlissandoEvent,
738 'slur' : musicexp.SlurEvent,
739 'wavy-line' : musicexp.TrillSpanEvent,
740 'wedge' : musicexp.HairpinEvent
742 spanner_type_dict = {
756 def musicxml_spanner_to_lily_event (mxl_event):
759 name = mxl_event.get_name()
760 func = spanner_event_dict.get (name)
764 error_message (_ ('unknown span event %s') % mxl_event)
767 type = mxl_event.get_type ()
768 span_direction = spanner_type_dict.get (type)
769 # really check for None, because some types will be translated to 0, which
770 # would otherwise also lead to the unknown span warning
771 if span_direction != None:
772 ev.span_direction = span_direction
774 error_message (_ ('unknown span type %s for %s') % (type, name))
776 ev.set_span_type (type)
777 ev.line_type = getattr (mxl_event, 'line-type', 'solid')
779 # assign the size, which is used for octave-shift, etc.
780 ev.size = mxl_event.get_size ()
784 def musicxml_direction_to_indicator (direction):
785 return { "above": 1, "upright": 1, "up": 1, "below": -1, "downright": -1, "down": -1, "inverted": -1 }.get (direction, 0)
787 def musicxml_fermata_to_lily_event (mxl_event):
788 ev = musicexp.ArticulationEvent ()
789 txt = mxl_event.get_text ()
790 # The contents of the element defined the shape, possible are normal, angled and square
791 ev.type = { "angled": "shortfermata", "square": "longfermata" }.get (txt, "fermata")
792 if hasattr (mxl_event, 'type'):
793 dir = musicxml_direction_to_indicator (mxl_event.type)
794 if dir and options.convert_directions:
795 ev.force_direction = dir
798 def musicxml_arpeggiate_to_lily_event (mxl_event):
799 ev = musicexp.ArpeggioEvent ()
800 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
803 def musicxml_nonarpeggiate_to_lily_event (mxl_event):
804 ev = musicexp.ArpeggioEvent ()
805 ev.non_arpeggiate = True
806 ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
809 def musicxml_tremolo_to_lily_event (mxl_event):
810 ev = musicexp.TremoloEvent ()
811 txt = mxl_event.get_text ()
818 def musicxml_falloff_to_lily_event (mxl_event):
819 ev = musicexp.BendEvent ()
823 def musicxml_doit_to_lily_event (mxl_event):
824 ev = musicexp.BendEvent ()
828 def musicxml_bend_to_lily_event (mxl_event):
829 ev = musicexp.BendEvent ()
830 ev.alter = mxl_event.bend_alter ()
833 def musicxml_caesura_to_lily_event (mxl_event):
834 ev = musicexp.MarkupEvent ()
835 # FIXME: default to straight or curved caesura?
836 ev.contents = "\\musicglyph #\"scripts.caesura.straight\""
837 ev.force_direction = 1
840 def musicxml_fingering_event (mxl_event):
841 ev = musicexp.ShortArticulationEvent ()
842 ev.type = mxl_event.get_text ()
845 def musicxml_snappizzicato_event (mxl_event):
846 needed_additional_definitions.append ("snappizzicato")
847 ev = musicexp.MarkupEvent ()
848 ev.contents = "\\snappizzicato"
851 def musicxml_string_event (mxl_event):
852 ev = musicexp.NoDirectionArticulationEvent ()
853 ev.type = mxl_event.get_text ()
856 def musicxml_accidental_mark (mxl_event):
857 ev = musicexp.MarkupEvent ()
858 contents = { "sharp": "\\sharp",
859 "natural": "\\natural",
861 "double-sharp": "\\doublesharp",
862 "sharp-sharp": "\\sharp\\sharp",
863 "flat-flat": "\\flat\\flat",
864 "flat-flat": "\\doubleflat",
865 "natural-sharp": "\\natural\\sharp",
866 "natural-flat": "\\natural\\flat",
867 "quarter-flat": "\\semiflat",
868 "quarter-sharp": "\\semisharp",
869 "three-quarters-flat": "\\sesquiflat",
870 "three-quarters-sharp": "\\sesquisharp",
871 }.get (mxl_event.get_text ())
873 ev.contents = contents
878 # translate articulations, ornaments and other notations into ArticulationEvents
880 # -) string (ArticulationEvent with that name)
881 # -) function (function(mxl_event) needs to return a full ArticulationEvent-derived object
882 # -) (class, name) (like string, only that a different class than ArticulationEvent is used)
883 # TODO: Some translations are missing!
884 articulations_dict = {
885 "accent": (musicexp.ShortArticulationEvent, ">"), # or "accent"
886 "accidental-mark": musicxml_accidental_mark,
887 "bend": musicxml_bend_to_lily_event,
888 "breath-mark": (musicexp.NoDirectionArticulationEvent, "breathe"),
889 "caesura": musicxml_caesura_to_lily_event,
890 #"delayed-turn": "?",
891 "detached-legato": (musicexp.ShortArticulationEvent, "_"), # or "portato"
892 "doit": musicxml_doit_to_lily_event,
893 #"double-tongue": "",
894 "down-bow": "downbow",
895 "falloff": musicxml_falloff_to_lily_event,
896 "fingering": musicxml_fingering_event,
900 "harmonic": "flageolet",
902 "inverted-mordent": "prall",
903 "inverted-turn": "reverseturn",
904 "mordent": "mordent",
905 "open-string": "open",
912 "snap-pizzicato": musicxml_snappizzicato_event,
914 "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
915 "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
916 "stopped": (musicexp.ShortArticulationEvent, "+"), # or "stopped"
918 "string": musicxml_string_event,
919 "strong-accent": (musicexp.ShortArticulationEvent, "^"), # or "marcato"
921 "tenuto": (musicexp.ShortArticulationEvent, "-"), # or "tenuto"
922 "thumb-position": "thumb",
925 "tremolo": musicxml_tremolo_to_lily_event,
926 "trill-mark": "trill",
927 #"triple-tongue": "",
932 articulation_spanners = [ "wavy-line" ]
934 def musicxml_articulation_to_lily_event (mxl_event):
935 # wavy-line elements are treated as trill spanners, not as articulation ornaments
936 if mxl_event.get_name () in articulation_spanners:
937 return musicxml_spanner_to_lily_event (mxl_event)
939 tmp_tp = articulations_dict.get (mxl_event.get_name ())
943 if isinstance (tmp_tp, str):
944 ev = musicexp.ArticulationEvent ()
946 elif isinstance (tmp_tp, tuple):
950 ev = tmp_tp (mxl_event)
952 # Some articulations use the type attribute, other the placement...
954 if hasattr (mxl_event, 'type') and options.convert_directions:
955 dir = musicxml_direction_to_indicator (mxl_event.type)
956 if hasattr (mxl_event, 'placement') and options.convert_directions:
957 dir = musicxml_direction_to_indicator (mxl_event.placement)
959 ev.force_direction = dir
964 def musicxml_dynamics_to_lily_event (dynentry):
965 dynamics_available = (
966 "ppppp", "pppp", "ppp", "pp", "p", "mp", "mf",
967 "f", "ff", "fff", "ffff", "fp", "sf", "sff", "sp", "spp", "sfz", "rfz" )
968 dynamicsname = dynentry.get_name ()
969 if dynamicsname == "other-dynamics":
970 dynamicsname = dynentry.get_text ()
971 if not dynamicsname or dynamicsname=="#text":
974 if not dynamicsname in dynamics_available:
975 # Get rid of - in tag names (illegal in ly tags!)
976 dynamicstext = dynamicsname
977 dynamicsname = string.replace (dynamicsname, "-", "")
978 additional_definitions[dynamicsname] = dynamicsname + \
979 " = #(make-dynamic-script \"" + dynamicstext + "\")"
980 needed_additional_definitions.append (dynamicsname)
981 event = musicexp.DynamicsEvent ()
982 event.type = dynamicsname
985 # Convert single-color two-byte strings to numbers 0.0 - 1.0
986 def hexcolorval_to_nr (hex_val):
988 v = int (hex_val, 16)
995 def hex_to_color (hex_val):
996 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)
998 return map (lambda x: hexcolorval_to_nr (x), res.group (2,3,4))
1002 def musicxml_words_to_lily_event (words):
1003 event = musicexp.TextEvent ()
1004 text = words.get_text ()
1005 text = re.sub ('^ *\n? *', '', text)
1006 text = re.sub (' *\n? *$', '', text)
1009 if hasattr (words, 'default-y') and options.convert_directions:
1010 offset = getattr (words, 'default-y')
1012 off = string.atoi (offset)
1014 event.force_direction = 1
1016 event.force_direction = -1
1018 event.force_direction = 0
1020 if hasattr (words, 'font-weight'):
1021 font_weight = { "normal": '', "bold": '\\bold' }.get (getattr (words, 'font-weight'), '')
1023 event.markup += font_weight
1025 if hasattr (words, 'font-size'):
1026 size = getattr (words, 'font-size')
1028 "xx-small": '\\teeny',
1029 "x-small": '\\tiny',
1033 "x-large": '\\huge',
1034 "xx-large": '\\bigger\\huge'
1037 event.markup += font_size
1039 if hasattr (words, 'color'):
1040 color = getattr (words, 'color')
1041 rgb = hex_to_color (color)
1043 event.markup += "\\with-color #(rgb-color %s %s %s)" % (rgb[0], rgb[1], rgb[2])
1045 if hasattr (words, 'font-style'):
1046 font_style = { "italic": '\\italic' }.get (getattr (words, 'font-style'), '')
1048 event.markup += font_style
1050 # TODO: How should I best convert the font-family attribute?
1052 # TODO: How can I represent the underline, overline and line-through
1053 # attributes in Lilypond? Values of these attributes indicate
1054 # the number of lines
1059 # convert accordion-registration to lilypond.
1060 # Since lilypond does not have any built-in commands, we need to create
1061 # the markup commands manually and define our own variables.
1062 # Idea was taken from: http://lsr.dsi.unimi.it/LSR/Item?id=194
1063 def musicxml_accordion_to_markup (mxl_event):
1064 commandname = "accReg"
1067 high = mxl_event.get_maybe_exist_named_child ('accordion-high')
1070 command += """\\combine
1071 \\raise #2.5 \\musicglyph #\"accordion.accDot\"
1073 middle = mxl_event.get_maybe_exist_named_child ('accordion-middle')
1075 # By default, use one dot (when no or invalid content is given). The
1076 # MusicXML spec is quiet about this case...
1079 txt = string.atoi (middle.get_text ())
1083 commandname += "MMM"
1084 command += """\\combine
1085 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1087 \\raise #1.5 \\translate #(cons 1 0) \\musicglyph #\"accordion.accDot\"
1089 \\raise #1.5 \\translate #(cons -1 0) \\musicglyph #\"accordion.accDot\"
1093 command += """\\combine
1094 \\raise #1.5 \\translate #(cons 0.5 0) \\musicglyph #\"accordion.accDot\"
1096 \\raise #1.5 \\translate #(cons -0.5 0) \\musicglyph #\"accordion.accDot\"
1100 command += """\\combine
1101 \\raise #1.5 \\musicglyph #\"accordion.accDot\"
1103 low = mxl_event.get_maybe_exist_named_child ('accordion-low')
1106 command += """\\combine
1107 \\raise #0.5 \musicglyph #\"accordion.accDot\"
1110 command += "\musicglyph #\"accordion.accDiscant\""
1111 command = "\\markup { \\normalsize %s }" % command
1112 # Define the newly built command \accReg[H][MMM][L]
1113 additional_definitions[commandname] = "%s = %s" % (commandname, command)
1114 needed_additional_definitions.append (commandname)
1115 return "\\%s" % commandname
1117 def musicxml_accordion_to_ly (mxl_event):
1118 txt = musicxml_accordion_to_markup (mxl_event)
1120 ev = musicexp.MarkEvent (txt)
1125 def musicxml_rehearsal_to_ly_mark (mxl_event):
1126 text = mxl_event.get_text ()
1129 # default is boxed rehearsal marks!
1131 if hasattr (mxl_event, 'enclosure'):
1132 encl = {"none": None, "square": "box", "circle": "circle" }.get (mxl_event.enclosure, None)
1134 text = "\\%s { %s }" % (encl, text)
1135 ev = musicexp.MarkEvent ("\\markup { %s }" % text)
1138 # translate directions into Events, possible values:
1139 # -) string (MarkEvent with that command)
1140 # -) function (function(mxl_event) needs to return a full Event-derived object
1141 # -) (class, name) (like string, only that a different class than MarkEvent is used)
1143 'accordion-registration' : musicxml_accordion_to_ly,
1144 'coda' : (musicexp.MusicGlyphMarkEvent, "coda"),
1147 # 'eyeglasses': ??????
1151 'rehearsal' : musicxml_rehearsal_to_ly_mark,
1153 'segno' : (musicexp.MusicGlyphMarkEvent, "segno"),
1154 'words' : musicxml_words_to_lily_event,
1156 directions_spanners = [ 'octave-shift', 'pedal', 'wedge', 'dashes', 'bracket' ]
1158 def musicxml_direction_to_lily (n):
1159 # TODO: Handle the <staff> element!
1161 # placement applies to all children!
1163 if hasattr (n, 'placement') and options.convert_directions:
1164 dir = musicxml_direction_to_indicator (n.placement)
1165 dirtype_children = []
1166 # TODO: The direction-type is used for grouping (e.g. dynamics with text),
1167 # so we can't simply flatten them out!
1168 for dt in n.get_typed_children (musicxml.DirType):
1169 dirtype_children += dt.get_all_children ()
1171 for entry in dirtype_children:
1172 # backets, dashes, octave shifts. pedal marks, hairpins etc. are spanners:
1173 if entry.get_name() in directions_spanners:
1174 event = musicxml_spanner_to_lily_event (entry)
1179 # now treat all the "simple" ones, that can be translated using the dict
1181 tmp_tp = directions_dict.get (entry.get_name (), None)
1182 if isinstance (tmp_tp, str): # string means MarkEvent
1183 ev = musicexp.MarkEvent (tmp_tp)
1184 elif isinstance (tmp_tp, tuple): # tuple means (EventClass, "text")
1185 ev = tmp_tp[0] (tmp_tp[1])
1189 # TODO: set the correct direction! Unfortunately, \mark in ly does
1190 # not seem to support directions!
1194 if entry.get_name () == "dynamics":
1195 for dynentry in entry.get_all_children ():
1196 ev = musicxml_dynamics_to_lily_event (dynentry)
1202 def musicxml_frame_to_lily_event (frame):
1203 ev = musicexp.FretEvent ()
1204 ev.strings = frame.get_strings ()
1205 ev.frets = frame.get_frets ()
1206 #offset = frame.get_first_fret () - 1
1208 for fn in frame.get_named_children ('frame-note'):
1209 fret = fn.get_fret ()
1212 el = [ fn.get_string (), fret ]
1213 fingering = fn.get_fingering ()
1215 el.append (fingering)
1216 ev.elements.append (el)
1219 barre[0] = el[0] # start string
1220 barre[2] = el[1] # fret
1222 barre[1] = el[0] # end string
1227 def musicxml_harmony_to_lily (n):
1229 for f in n.get_named_children ('frame'):
1230 ev = musicxml_frame_to_lily_event (f)
1236 instrument_drumtype_dict = {
1237 'Acoustic Snare Drum': 'acousticsnare',
1238 'Side Stick': 'sidestick',
1239 'Open Triangle': 'opentriangle',
1240 'Mute Triangle': 'mutetriangle',
1241 'Tambourine': 'tambourine',
1242 'Bass Drum': 'bassdrum',
1245 def musicxml_note_to_lily_main_event (n):
1250 mxl_pitch = n.get_maybe_exist_typed_child (musicxml.Pitch)
1252 pitch = musicxml_pitch_to_lily (mxl_pitch)
1253 event = musicexp.NoteEvent ()
1256 acc = n.get_maybe_exist_named_child ('accidental')
1258 # let's not force accs everywhere.
1259 event.cautionary = acc.editorial
1261 elif n.get_maybe_exist_typed_child (musicxml.Unpitched):
1262 # Unpitched elements have display-step and can also have
1264 unpitched = n.get_maybe_exist_typed_child (musicxml.Unpitched)
1265 event = musicexp.NoteEvent ()
1266 event.pitch = musicxml_unpitched_to_lily (unpitched)
1268 elif n.get_maybe_exist_typed_child (musicxml.Rest):
1269 # rests can have display-octave and display-step, which are
1270 # treated like an ordinary note pitch
1271 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1272 event = musicexp.RestEvent ()
1273 pitch = musicxml_restdisplay_to_lily (rest)
1276 elif n.instrument_name:
1277 event = musicexp.NoteEvent ()
1278 drum_type = instrument_drumtype_dict.get (n.instrument_name)
1280 event.drum_type = drum_type
1282 n.message (_ ("drum %s type unknown, please add to instrument_drumtype_dict") % n.instrument_name)
1283 event.drum_type = 'acousticsnare'
1286 n.message (_ ("cannot find suitable event"))
1289 event.duration = musicxml_duration_to_lily (n)
1296 def __init__ (self, here, dest):
1300 class LilyPondVoiceBuilder:
1301 def __init__ (self):
1303 self.pending_dynamics = []
1304 self.end_moment = Rational (0)
1305 self.begin_moment = Rational (0)
1306 self.pending_multibar = Rational (0)
1307 self.ignore_skips = False
1309 def _insert_multibar (self):
1310 r = musicexp.MultiMeasureRest ()
1311 r.duration = musicexp.Duration()
1312 r.duration.duration_log = 0
1313 r.duration.factor = self.pending_multibar
1314 self.elements.append (r)
1315 self.begin_moment = self.end_moment
1316 self.end_moment = self.begin_moment + self.pending_multibar
1317 self.pending_multibar = Rational (0)
1319 def add_multibar_rest (self, duration):
1320 self.pending_multibar += duration
1322 def set_duration (self, duration):
1323 self.end_moment = self.begin_moment + duration
1324 def current_duration (self):
1325 return self.end_moment - self.begin_moment
1327 def add_music (self, music, duration):
1328 assert isinstance (music, musicexp.Music)
1329 if self.pending_multibar > Rational (0):
1330 self._insert_multibar ()
1332 self.elements.append (music)
1333 self.begin_moment = self.end_moment
1334 self.set_duration (duration)
1336 # Insert all pending dynamics right after the note/rest:
1337 if isinstance (music, musicexp.ChordEvent) and self.pending_dynamics:
1338 for d in self.pending_dynamics:
1340 self.pending_dynamics = []
1342 # Insert some music command that does not affect the position in the measure
1343 def add_command (self, command):
1344 assert isinstance (command, musicexp.Music)
1345 if self.pending_multibar > Rational (0):
1346 self._insert_multibar ()
1347 self.elements.append (command)
1348 def add_barline (self, barline):
1349 # TODO: Implement merging of default barline and custom bar line
1350 self.add_music (barline, Rational (0))
1351 def add_partial (self, command):
1352 self.ignore_skips = True
1353 self.add_command (command)
1355 def add_dynamics (self, dynamic):
1356 # store the dynamic item(s) until we encounter the next note/rest:
1357 self.pending_dynamics.append (dynamic)
1359 def add_bar_check (self, number):
1360 b = musicexp.BarLine ()
1361 b.bar_number = number
1362 self.add_barline (b)
1364 def jumpto (self, moment):
1365 current_end = self.end_moment + self.pending_multibar
1366 diff = moment - current_end
1368 if diff < Rational (0):
1369 error_message (_ ('Negative skip %s') % diff)
1372 if diff > Rational (0) and not (self.ignore_skips and moment == 0):
1373 skip = musicexp.SkipEvent()
1375 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)
1377 if duration_log > 0: # denominator is a power of 2...
1378 if diff.numerator () == 3:
1382 duration_factor = Rational (diff.numerator ())
1385 duration_factor = diff
1386 skip.duration.duration_log = duration_log
1387 skip.duration.factor = duration_factor
1388 skip.duration.dots = duration_dots
1390 evc = musicexp.ChordEvent ()
1391 evc.elements.append (skip)
1392 self.add_music (evc, diff)
1394 if diff > Rational (0) and moment == 0:
1395 self.ignore_skips = False
1397 def last_event_chord (self, starting_at):
1401 # if the position matches, find the last ChordEvent, do not cross a bar line!
1402 at = len( self.elements ) - 1
1404 not isinstance (self.elements[at], musicexp.ChordEvent) and
1405 not isinstance (self.elements[at], musicexp.BarLine)):
1410 and isinstance (self.elements[at], musicexp.ChordEvent)
1411 and self.begin_moment == starting_at):
1412 value = self.elements[at]
1414 self.jumpto (starting_at)
1418 def correct_negative_skip (self, goto):
1419 self.end_moment = goto
1420 self.begin_moment = goto
1421 evc = musicexp.ChordEvent ()
1422 self.elements.append (evc)
1426 def __init__ (self):
1427 self.voicedata = None
1428 self.ly_voice = None
1429 self.lyrics_dict = {}
1430 self.lyrics_order = []
1432 def musicxml_step_to_lily (step):
1434 return (ord (step) - ord ('A') + 7 - 2) % 7
1438 def musicxml_voice_to_lily_voice (voice):
1442 return_value = VoiceData ()
1443 return_value.voicedata = voice
1445 # First pitch needed for relative mode (if selected in command-line options)
1448 # Needed for melismata detection (ignore lyrics on those notes!):
1452 ignore_lyrics = False
1454 current_staff = None
1456 # Make sure that the keys in the dict don't get reordered, since
1457 # we need the correct ordering of the lyrics stanzas! By default,
1458 # a dict will reorder its keys
1459 return_value.lyrics_order = voice.get_lyrics_numbers ()
1460 for k in return_value.lyrics_order:
1463 voice_builder = LilyPondVoiceBuilder()
1465 for n in voice._elements:
1466 if n.get_name () == 'forward':
1468 staff = n.get_maybe_exist_named_child ('staff')
1470 staff = staff.get_text ()
1471 if current_staff and staff <> current_staff and not n.get_maybe_exist_named_child ('chord'):
1472 voice_builder.add_command (musicexp.StaffChange (staff))
1473 current_staff = staff
1475 if isinstance (n, musicxml.Partial) and n.partial > 0:
1476 a = musicxml_partial_to_lily (n.partial)
1478 voice_builder.add_partial (a)
1481 if isinstance (n, musicxml.Direction):
1482 for a in musicxml_direction_to_lily (n):
1483 if a.wait_for_note ():
1484 voice_builder.add_dynamics (a)
1486 voice_builder.add_command (a)
1489 if isinstance (n, musicxml.Harmony):
1490 for a in musicxml_harmony_to_lily (n):
1491 if a.wait_for_note ():
1492 voice_builder.add_dynamics (a)
1494 voice_builder.add_command (a)
1497 is_chord = n.get_maybe_exist_named_child ('chord')
1500 voice_builder.jumpto (n._when)
1501 except NegativeSkip, neg:
1502 voice_builder.correct_negative_skip (n._when)
1503 n.message (_ ("Negative skip found: from %s to %s, difference is %s") % (neg.here, neg.dest, neg.dest - neg.here))
1505 if isinstance (n, musicxml.Attributes):
1506 if n.is_first () and n._measure_position == Rational (0):
1508 number = int (n.get_parent ().number)
1512 voice_builder.add_bar_check (number)
1514 for a in musicxml_attributes_to_lily (n):
1515 voice_builder.add_command (a)
1518 if isinstance (n, musicxml.Barline):
1519 barlines = musicxml_barline_to_lily (n)
1521 if isinstance (a, musicexp.BarLine):
1522 voice_builder.add_barline (a)
1523 elif isinstance (a, RepeatMarker) or isinstance (a, EndingMarker):
1524 voice_builder.add_command (a)
1527 if not n.__class__.__name__ == 'Note':
1528 error_message (_ ('unexpected %s; expected %s or %s or %s') % (n, 'Note', 'Attributes', 'Barline'))
1531 rest = n.get_maybe_exist_typed_child (musicxml.Rest)
1533 and rest.is_whole_measure ()):
1535 voice_builder.add_multibar_rest (n._duration)
1538 if n.is_first () and n._measure_position == Rational (0):
1540 num = int (n.get_parent ().number)
1544 voice_builder.add_bar_check (num)
1546 main_event = musicxml_note_to_lily_main_event (n)
1547 if main_event and not first_pitch:
1548 first_pitch = main_event.pitch
1549 ignore_lyrics = inside_slur or is_tied or is_chord
1551 if main_event and hasattr (main_event, 'drum_type') and main_event.drum_type:
1552 modes_found['drummode'] = True
1554 ev_chord = voice_builder.last_event_chord (n._when)
1556 ev_chord = musicexp.ChordEvent()
1557 voice_builder.add_music (ev_chord, n._duration)
1559 grace = n.get_maybe_exist_typed_child (musicxml.Grace)
1562 if n.get_maybe_exist_typed_child (musicxml.Chord) and ev_chord.grace_elements:
1563 grace_chord = ev_chord.grace_elements.get_last_event_chord ()
1565 grace_chord = musicexp.ChordEvent ()
1566 ev_chord.append_grace (grace_chord)
1567 if hasattr (grace, 'slash'):
1568 # TODO: use grace_type = "appoggiatura" for slurred grace notes
1569 if grace.slash == "yes":
1570 ev_chord.grace_type = "acciaccatura"
1571 # now that we have inserted the chord into the grace music, insert
1572 # everything into that chord instead of the ev_chord
1573 ev_chord = grace_chord
1574 ev_chord.append (main_event)
1575 ignore_lyrics = True
1577 ev_chord.append (main_event)
1578 # When a note/chord has grace notes (duration==0), the duration of the
1579 # event chord is not yet known, but the event chord was already added
1580 # with duration 0. The following correct this when we hit the real note!
1581 if voice_builder.current_duration () == 0 and n._duration > 0:
1582 voice_builder.set_duration (n._duration)
1584 notations_children = n.get_typed_children (musicxml.Notations)
1588 # The <notation> element can have the following children (+ means implemented, ~ partially, - not):
1589 # +tied | +slur | +tuplet | glissando | slide |
1590 # ornaments | technical | articulations | dynamics |
1591 # +fermata | arpeggiate | non-arpeggiate |
1592 # accidental-mark | other-notation
1593 for notations in notations_children:
1594 for tuplet_event in notations.get_tuplets():
1595 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1598 frac = mod.get_fraction ()
1600 tuplet_events.append ((ev_chord, tuplet_event, frac))
1602 slurs = [s for s in notations.get_named_children ('slur')
1603 if s.get_type () in ('start','stop')]
1606 error_message (_ ('cannot have two simultaneous slurs'))
1607 # record the slur status for the next note in the loop
1609 if slurs[0].get_type () == 'start':
1611 elif slurs[0].get_type () == 'stop':
1613 lily_ev = musicxml_spanner_to_lily_event (slurs[0])
1614 ev_chord.append (lily_ev)
1617 mxl_tie = notations.get_tie ()
1618 if mxl_tie and mxl_tie.type == 'start':
1619 ev_chord.append (musicexp.TieEvent ())
1624 fermatas = notations.get_named_children ('fermata')
1626 ev = musicxml_fermata_to_lily_event (a)
1628 ev_chord.append (ev)
1630 arpeggiate = notations.get_named_children ('arpeggiate')
1631 for a in arpeggiate:
1632 ev = musicxml_arpeggiate_to_lily_event (a)
1634 ev_chord.append (ev)
1636 arpeggiate = notations.get_named_children ('non-arpeggiate')
1637 for a in arpeggiate:
1638 ev = musicxml_nonarpeggiate_to_lily_event (a)
1640 ev_chord.append (ev)
1642 glissandos = notations.get_named_children ('glissando')
1643 glissandos += notations.get_named_children ('slide')
1644 for a in glissandos:
1645 ev = musicxml_spanner_to_lily_event (a)
1647 ev_chord.append (ev)
1649 # Articulations can contain the following child elements:
1650 # accent | strong-accent | staccato | tenuto |
1651 # detached-legato | staccatissimo | spiccato |
1652 # scoop | plop | doit | falloff | breath-mark |
1653 # caesura | stress | unstress
1654 # Technical can contain the following child elements:
1655 # up-bow | down-bow | harmonic | open-string |
1656 # thumb-position | fingering | pluck | double-tongue |
1657 # triple-tongue | stopped | snap-pizzicato | fret |
1658 # string | hammer-on | pull-off | bend | tap | heel |
1659 # toe | fingernails | other-technical
1660 # Ornaments can contain the following child elements:
1661 # trill-mark | turn | delayed-turn | inverted-turn |
1662 # shake | wavy-line | mordent | inverted-mordent |
1663 # schleifer | tremolo | other-ornament, accidental-mark
1664 ornaments = notations.get_named_children ('ornaments')
1665 ornaments += notations.get_named_children ('articulations')
1666 ornaments += notations.get_named_children ('technical')
1669 for ch in a.get_all_children ():
1670 ev = musicxml_articulation_to_lily_event (ch)
1672 ev_chord.append (ev)
1674 dynamics = notations.get_named_children ('dynamics')
1676 for ch in a.get_all_children ():
1677 ev = musicxml_dynamics_to_lily_event (ch)
1679 ev_chord.append (ev)
1681 # Extract the lyrics
1682 if not rest and not ignore_lyrics:
1683 note_lyrics_processed = []
1684 note_lyrics_elements = n.get_typed_children (musicxml.Lyric)
1685 for l in note_lyrics_elements:
1686 if l.get_number () < 0:
1687 for k in lyrics.keys ():
1688 lyrics[k].append (l.lyric_to_text ())
1689 note_lyrics_processed.append (k)
1691 lyrics[l.number].append(l.lyric_to_text ())
1692 note_lyrics_processed.append (l.number)
1693 for lnr in lyrics.keys ():
1694 if not lnr in note_lyrics_processed:
1695 lyrics[lnr].append ("\skip4")
1698 mxl_beams = [b for b in n.get_named_children ('beam')
1699 if (b.get_type () in ('begin', 'end')
1700 and b.is_primary ())]
1701 if mxl_beams and not conversion_settings.ignore_beaming:
1702 beam_ev = musicxml_spanner_to_lily_event (mxl_beams[0])
1704 ev_chord.append (beam_ev)
1707 mod = n.get_maybe_exist_typed_child (musicxml.Time_modification)
1710 frac = mod.get_fraction ()
1712 tuplet_events.append ((ev_chord, tuplet_event, frac))
1714 ## force trailing mm rests to be written out.
1715 voice_builder.add_music (musicexp.ChordEvent (), Rational (0))
1717 ly_voice = group_tuplets (voice_builder.elements, tuplet_events)
1718 ly_voice = group_repeats (ly_voice)
1720 seq_music = musicexp.SequentialMusic ()
1722 if 'drummode' in modes_found.keys ():
1723 ## \key <pitch> barfs in drummode.
1724 ly_voice = [e for e in ly_voice
1725 if not isinstance(e, musicexp.KeySignatureChange)]
1727 seq_music.elements = ly_voice
1728 for k in lyrics.keys ():
1729 return_value.lyrics_dict[k] = musicexp.Lyrics ()
1730 return_value.lyrics_dict[k].lyrics_syllables = lyrics[k]
1733 if len (modes_found) > 1:
1734 error_message (_ ('cannot simultaneously have more than one mode: %s') % modes_found.keys ())
1736 if options.relative:
1737 v = musicexp.RelativeMusic ()
1738 v.element = seq_music
1739 v.basepitch = first_pitch
1742 return_value.ly_voice = seq_music
1743 for mode in modes_found.keys ():
1744 v = musicexp.ModeChangingMusicWrapper()
1745 v.element = seq_music
1747 return_value.ly_voice = v
1751 def musicxml_id_to_lily (id):
1752 digits = ['Zero', 'One', 'Two', 'Three', 'Four', 'Five',
1753 'Six', 'Seven', 'Eight', 'Nine', 'Ten']
1755 for digit in digits:
1756 d = digits.index (digit)
1757 id = re.sub ('%d' % d, digit, id)
1759 id = re.sub ('[^a-zA-Z]', 'X', id)
1762 def musicxml_pitch_to_lily (mxl_pitch):
1763 p = musicexp.Pitch ()
1764 p.alteration = mxl_pitch.get_alteration ()
1765 p.step = musicxml_step_to_lily (mxl_pitch.get_step ())
1766 p.octave = mxl_pitch.get_octave () - 4
1769 def musicxml_unpitched_to_lily (mxl_unpitched):
1771 step = mxl_unpitched.get_step ()
1773 p = musicexp.Pitch ()
1774 p.step = musicxml_step_to_lily (step)
1775 octave = mxl_unpitched.get_octave ()
1777 p.octave = octave - 4
1780 def musicxml_restdisplay_to_lily (mxl_rest):
1782 step = mxl_rest.get_step ()
1784 p = musicexp.Pitch ()
1785 p.step = musicxml_step_to_lily (step)
1786 octave = mxl_rest.get_octave ()
1788 p.octave = octave - 4
1791 def voices_in_part (part):
1792 """Return a Name -> Voice dictionary for PART"""
1794 part.extract_voices ()
1795 voices = part.get_voices ()
1796 part_info = part.get_staff_attributes ()
1798 return (voices, part_info)
1800 def voices_in_part_in_parts (parts):
1801 """return a Part -> Name -> Voice dictionary"""
1802 return dict([(p.id, voices_in_part (p)) for p in parts])
1805 def get_all_voices (parts):
1806 all_voices = voices_in_part_in_parts (parts)
1809 all_ly_staffinfo = {}
1810 for p, (name_voice, staff_info) in all_voices.items ():
1813 for n, v in name_voice.items ():
1814 progress (_ ("Converting to LilyPond expressions..."))
1815 # musicxml_voice_to_lily_voice returns (lily_voice, {nr->lyrics, nr->lyrics})
1816 part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
1818 all_ly_voices[p] = part_ly_voices
1819 all_ly_staffinfo[p] = staff_info
1821 return (all_ly_voices, all_ly_staffinfo)
1824 def option_parser ():
1825 p = ly.get_option_parser (usage = _ ("musicxml2ly [options] FILE.xml"),
1826 description = _ ("Convert %s to LilyPond input.") % 'MusicXML' + "\n",
1827 add_help_option=False)
1829 p.add_option("-h", "--help",
1831 help=_ ("show this help and exit"))
1833 p.version = ('''%prog (LilyPond) @TOPLEVEL_VERSION@\n\n'''
1835 _ ("""This program is free software. It is covered by the GNU General Public
1836 License and you are welcome to change it and/or distribute copies of it
1837 under certain conditions. Invoke as `%s --warranty' for more
1838 information.""") % 'lilypond'
1840 Copyright (c) 2005--2008 by
1841 Han-Wen Nienhuys <hanwen@xs4all.nl>,
1842 Jan Nieuwenhuizen <janneke@gnu.org> and
1843 Reinhold Kainhofer <reinhold@kainhofer.com>
1845 p.add_option("--version",
1847 help=_ ("show version number and exit"))
1849 p.add_option ('-v', '--verbose',
1850 action = "store_true",
1852 help = _ ("be verbose"))
1854 p.add_option ('', '--lxml',
1855 action = "store_true",
1858 help = _ ("use lxml.etree; uses less memory and cpu time"))
1860 p.add_option ('-z', '--compressed',
1861 action = "store_true",
1862 dest = 'compressed',
1864 help = _ ("input file is a zip-compressed MusicXML file"))
1866 p.add_option ('-r', '--relative',
1867 action = "store_true",
1870 help = _ ("convert pitches in relative mode (default)"))
1872 p.add_option ('-a', '--absolute',
1873 action = "store_false",
1875 help = _ ("convert pitches in absolute mode"))
1877 p.add_option ('-l', '--language',
1878 metavar = _ ("LANG"),
1880 help = _ ("use a different language file 'LANG.ly' and corresponding pitch names, e.g. 'deutsch' for deutsch.ly"))
1882 p.add_option ('--nd', '--no-articulation-directions',
1883 action = "store_false",
1885 dest = "convert_directions",
1886 help = _ ("do not convert directions (^, _ or -) for articulations, dynamics, etc."))
1888 p.add_option ('--no-beaming',
1889 action = "store_false",
1891 dest = "convert_beaming",
1892 help = _ ("do not convert beaming information, use lilypond's automatic beaming instead"))
1894 p.add_option ('-o', '--output',
1895 metavar = _ ("FILE"),
1899 dest = 'output_name',
1900 help = _ ("set output filename to FILE"))
1901 p.add_option_group (ly.display_encode (_ ('Bugs')),
1902 description = (_ ("Report bugs via")
1903 + ''' http://post.gmane.org/post.php'''
1904 '''?group=gmane.comp.gnu.lilypond.bugs\n'''))
1907 def music_xml_voice_name_to_lily_name (part_id, name):
1908 str = "Part%sVoice%s" % (part_id, name)
1909 return musicxml_id_to_lily (str)
1911 def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
1912 str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
1913 return musicxml_id_to_lily (str)
1915 def print_voice_definitions (printer, part_list, voices):
1916 for part in part_list:
1918 nv_dict = voices.get (part_id, {})
1919 for (name, voice) in nv_dict.items ():
1920 k = music_xml_voice_name_to_lily_name (part_id, name)
1921 printer.dump ('%s = ' % k)
1922 voice.ly_voice.print_ly (printer)
1924 for l in voice.lyrics_order:
1925 lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
1926 printer.dump ('%s = ' %lname )
1927 voice.lyrics_dict[l].print_ly (printer)
1932 return dict ([(elt,1) for elt in l]).keys ()
1934 # format the information about the staff in the form
1937 # [voiceid1, [lyricsid11, lyricsid12,...] ...],
1938 # [voiceid2, [lyricsid21, lyricsid22,...] ...],
1942 # raw_voices is of the form [(voicename, lyricsids)*]
1943 def format_staff_info (part_id, staff_id, raw_voices):
1945 for (v, lyricsids) in raw_voices:
1946 voice_name = music_xml_voice_name_to_lily_name (part_id, v)
1947 voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
1949 voices.append ([voice_name, voice_lyrics])
1950 return [staff_id, voices]
1952 def update_score_setup (score_structure, part_list, voices):
1954 for part_definition in part_list:
1955 part_id = part_definition.id
1956 nv_dict = voices.get (part_id)
1958 error_message (_ ('unknown part in part-list: %s') % part_id)
1961 staves = reduce (lambda x,y: x+ y,
1962 [voice.voicedata._staves.keys ()
1963 for voice in nv_dict.values ()],
1966 if len (staves) > 1:
1968 staves = uniq_list (staves)
1971 thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1972 for (voice_name, voice) in nv_dict.items ()
1973 if voice.voicedata._start_staff == s]
1974 staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
1976 thisstaff_raw_voices = [(voice_name, voice.lyrics_order)
1977 for (voice_name, voice) in nv_dict.items ()]
1978 staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
1979 score_structure.set_part_information (part_id, staves_info)
1981 # Set global values in the \layout block, like auto-beaming etc.
1982 def update_layout_information ():
1983 if not conversion_settings.ignore_beaming and layout_information:
1984 layout_information.set_context_item ('Score', 'autoBeaming = ##f')
1986 def print_ly_preamble (printer, filename):
1987 printer.dump_version ()
1988 printer.print_verbatim ('%% automatically converted from %s\n' % filename)
1990 def print_ly_additional_definitions (printer, filename):
1991 if needed_additional_definitions:
1993 printer.print_verbatim ('%% additional definitions required by the score:')
1995 for a in set(needed_additional_definitions):
1996 printer.print_verbatim (additional_definitions.get (a, ''))
2000 # Read in the tree from the given I/O object (either file or string) and
2001 # demarshall it using the classes from the musicxml.py file
2002 def read_xml (io_object, use_lxml):
2005 tree = lxml.etree.parse (io_object)
2006 mxl_tree = musicxml.lxml_demarshal_node (tree.getroot ())
2009 from xml.dom import minidom, Node
2010 doc = minidom.parse(io_object)
2011 node = doc.documentElement
2012 return musicxml.minidom_demarshal_node (node)
2016 def read_musicxml (filename, compressed, use_lxml):
2019 progress (_ ("Input file %s is compressed, extracting raw MusicXML data") % filename)
2020 z = zipfile.ZipFile (filename, "r")
2021 container_xml = z.read ("META-INF/container.xml")
2022 if not container_xml:
2024 container = read_xml (StringIO.StringIO (container_xml), use_lxml)
2027 rootfiles = container.get_maybe_exist_named_child ('rootfiles')
2030 rootfile_list = rootfiles.get_named_children ('rootfile')
2032 if len (rootfile_list) > 0:
2033 mxml_file = getattr (rootfile_list[0], 'full-path', None)
2035 raw_string = z.read (mxml_file)
2037 io_object = filename
2039 io_object = StringIO.StringIO (raw_string)
2041 return read_xml (io_object, use_lxml)
2044 def convert (filename, options):
2045 progress (_ ("Reading MusicXML from %s ...") % filename)
2047 tree = read_musicxml (filename, options.compressed, options.use_lxml)
2048 score_information = extract_score_information (tree)
2049 paper_information = extract_paper_information (tree)
2051 parts = tree.get_typed_children (musicxml.Part)
2052 (voices, staff_info) = get_all_voices (parts)
2054 score_structure = None
2055 mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
2057 score_structure = extract_score_structure (mxl_pl, staff_info)
2058 part_list = mxl_pl.get_named_children ("score-part")
2060 # score information is contained in the <work>, <identification> or <movement-title> tags
2061 update_score_setup (score_structure, part_list, voices)
2062 # After the conversion, update the list of settings for the \layout block
2063 update_layout_information ()
2065 if not options.output_name:
2066 options.output_name = os.path.basename (filename)
2067 options.output_name = os.path.splitext (options.output_name)[0]
2068 elif re.match (".*\.ly", options.output_name):
2069 options.output_name = os.path.splitext (options.output_name)[0]
2072 defs_ly_name = options.output_name + '-defs.ly'
2073 driver_ly_name = options.output_name + '.ly'
2075 printer = musicexp.Output_printer()
2076 progress (_ ("Output to `%s'") % defs_ly_name)
2077 printer.set_file (codecs.open (defs_ly_name, 'wb', encoding='utf-8'))
2079 print_ly_preamble (printer, filename)
2080 print_ly_additional_definitions (printer, filename)
2081 if score_information:
2082 score_information.print_ly (printer)
2083 if paper_information:
2084 paper_information.print_ly (printer)
2085 if layout_information:
2086 layout_information.print_ly (printer)
2087 print_voice_definitions (printer, part_list, voices)
2092 progress (_ ("Output to `%s'") % driver_ly_name)
2093 printer = musicexp.Output_printer()
2094 printer.set_file (codecs.open (driver_ly_name, 'wb', encoding='utf-8'))
2095 print_ly_preamble (printer, filename)
2096 printer.dump (r'\include "%s"' % os.path.basename (defs_ly_name))
2097 score_structure.print_ly (printer)
2102 def get_existing_filename_with_extension (filename, ext):
2103 if os.path.exists (filename):
2105 newfilename = filename + "." + ext
2106 if os.path.exists (newfilename):
2108 newfilename = filename + ext
2109 if os.path.exists (newfilename):
2114 opt_parser = option_parser()
2117 (options, args) = opt_parser.parse_args ()
2119 opt_parser.print_usage()
2122 if options.language:
2123 musicexp.set_pitch_language (options.language)
2124 needed_additional_definitions.append (options.language)
2125 additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
2126 conversion_settings.ignore_beaming = not options.convert_beaming
2128 # Allow the user to leave out the .xml or xml on the filename
2129 filename = get_existing_filename_with_extension (args[0], "xml")
2131 filename = get_existing_filename_with_extension (args[0], "mxl")
2132 options.compressed = True
2133 if filename and os.path.exists (filename):
2134 voices = convert (filename, options)
2136 progress (_ ("Unable to find input file %s") % args[0])
2138 if __name__ == '__main__':