]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/musicxml2ly.py
MusicXML: Add command line option to not convert directions on articulations, etc.
[lilypond.git] / scripts / musicxml2ly.py
index 9b99d3abd0897182f3a608ba6261fe8e10041465..e04578aecd1de62227aa71ef5dfcdf60b6149a5d 100644 (file)
@@ -19,6 +19,8 @@ import musicexp
 
 from rational import Rational
 
+# Store command-line options in a global variable, so we can access them everythwere
+options = None
 
 def progress (str):
     sys.stderr.write (str + '\n')
@@ -28,6 +30,120 @@ def error_message (str):
     sys.stderr.write (str + '\n')
     sys.stderr.flush ()
 
+needed_additional_definitions = []
+additional_definitions = {
+  "snappizzicato": """#(define-markup-command (snappizzicato layout props) ()
+  (interpret-markup layout props
+    (markup #:stencil
+      (ly:stencil-translate-axis
+        (ly:stencil-add
+          (make-circle-stencil 0.7 0.1 #f)
+          (ly:make-stencil
+            (list 'draw-line 0.1 0 0.1 0 1)
+            '(-0.1 . 0.1) '(0.1 . 1)
+          )
+        )
+        0.7 X
+      )
+    )
+  )
+)
+"""
+}
+
+def round_to_two_digits (val):
+    return round (val * 100) / 100
+
+def extract_layout_information (tree):
+    paper = musicexp.Paper ()
+    defaults = tree.get_maybe_exist_named_child ('defaults')
+    if not defaults:
+        return None
+    tenths = -1
+    scaling = defaults.get_maybe_exist_named_child ('scaling')
+    if scaling:
+        mm = scaling.get_named_child ('millimeters')
+        mm = string.atof (mm.get_text ())
+        tn = scaling.get_maybe_exist_named_child ('tenths')
+        tn = string.atof (tn.get_text ())
+        tenths = mm / tn
+        paper.global_staff_size = mm * 72.27 / 25.4
+    # We need the scaling (i.e. the size of staff tenths for everything!
+    if tenths < 0:
+        return None
+
+    def from_tenths (txt):
+        return round_to_two_digits (string.atof (txt) * tenths / 10)
+    def set_paper_variable (varname, parent, element_name):
+        el = parent.get_maybe_exist_named_child (element_name)
+        if el: # Convert to cm from tenths
+            setattr (paper, varname, from_tenths (el.get_text ()))
+
+    pagelayout = defaults.get_maybe_exist_named_child ('page-layout')
+    if pagelayout:
+        # TODO: How can one have different margins for even and odd pages???
+        set_paper_variable ("page_height", pagelayout, 'page-height')
+        set_paper_variable ("page_width", pagelayout, 'page-width')
+
+        pmargins = pagelayout.get_named_children ('page-margins')
+        for pm in pmargins:
+            set_paper_variable ("left_margin", pm, 'left-margin')
+            set_paper_variable ("right_margin", pm, 'right-margin')
+            set_paper_variable ("bottom_margin", pm, 'bottom-margin')
+            set_paper_variable ("top_margin", pm, 'top-margin')
+
+    systemlayout = defaults.get_maybe_exist_named_child ('system-layout')
+    if systemlayout:
+        sl = systemlayout.get_maybe_exist_named_child ('system-margins')
+        if sl:
+            set_paper_variable ("system_left_margin", sl, 'left-margin')
+            set_paper_variable ("system_right_margin", sl, 'right-margin')
+        set_paper_variable ("system_distance", systemlayout, 'system-distance')
+        set_paper_variable ("top_system_distance", systemlayout, 'top-system-distance')
+
+    stafflayout = defaults.get_named_children ('staff-layout')
+    for sl in stafflayout:
+        nr = getattr (sl, 'number', 1)
+        dist = sl.get_named_child ('staff-distance')
+        #TODO: the staff distance needs to be set in the Staff context!!!
+
+    # TODO: Finish appearance?, music-font?, word-font?, lyric-font*, lyric-language*
+    appearance = defaults.get_named_child ('appearance')
+    if appearance:
+        lws = appearance.get_named_children ('line-width')
+        for lw in lws:
+            # Possible types are: beam, bracket, dashes,
+            #    enclosure, ending, extend, heavy barline, leger,
+            #    light barline, octave shift, pedal, slur middle, slur tip,
+            #    staff, stem, tie middle, tie tip, tuplet bracket, and wedge
+            tp = lw.type
+            w = from_tenths (lw.get_data ())
+            # TODO: Do something with these values!
+        nss = appearance.get_named_children ('note-size')
+        for ns in nss:
+            # Possible types are: cue, grace and large
+            tp = ns.type
+            sz = from_tenths (ns.get_data ())
+            # TODO: Do something with these values!
+        # <other-appearance> elements have no specified meaning
+
+    rawmusicfont = defaults.get_named_child ('music-font')
+    if rawmusicfont:
+        # TODO: Convert the font
+        pass
+    rawwordfont = defaults.get_named_child ('word-font')
+    if rawwordfont:
+        # TODO: Convert the font
+        pass
+    rawlyricsfonts = defaults.get_named_children ('lyric-font')
+    for lyricsfont in rawlyricsfonts:
+        # TODO: Convert the font
+        pass
+
+    return paper
+
+
+
 # score information is contained in the <work>, <identification> or <movement-title> tags
 # extract those into a hash, indexed by proper lilypond header attributes
 def extract_score_information (tree):
@@ -79,7 +195,83 @@ class PartGroupInfo:
         return ''
 
 
-def extract_score_layout (part_list):
+def staff_attributes_to_string_tunings (mxl_attr):
+    details = mxl_attr.get_maybe_exist_named_child ('staff-details')
+    if not details:
+        return []
+    lines = 6
+    staff_lines = details.get_maybe_exist_named_child ('staff-lines')
+    if staff_lines:
+        lines = string.atoi (staff_lines.get_text ())
+
+    tunings = [0]*lines
+    staff_tunings = details.get_named_children ('staff-tuning')
+    for i in staff_tunings:
+        p = musicexp.Pitch()
+        line = 0
+        try:
+            line = string.atoi (i.line) - 1
+        except ValueError:
+            pass
+        tunings[line] = p
+
+        step = i.get_named_child (u'tuning-step')
+        step = step.get_text ().strip ()
+        p.step = (ord (step) - ord ('A') + 7 - 2) % 7
+
+        octave = i.get_named_child (u'tuning-octave')
+        octave = octave.get_text ().strip ()
+        p.octave = int (octave) - 4
+
+        alter = i.get_named_child (u'tuning-alter')
+        if alter:
+            p.alteration = int (alter.get_text ().strip ())
+    # lilypond seems to use the opposite ordering than MusicXML...
+    tunings.reverse ()
+
+    return tunings
+
+
+def staff_attributes_to_lily_staff (mxl_attr):
+    if not mxl_attr:
+        return musicexp.Staff ()
+
+    (staff_id, attributes) = mxl_attr.items ()[0]
+
+    # distinguish by clef:
+    # percussion (percussion and rhythmic), tab, and everything else
+    clef_sign = None
+    clef = attributes.get_maybe_exist_named_child ('clef')
+    if clef:
+        sign = clef.get_maybe_exist_named_child ('sign')
+        if sign:
+            clef_sign = {"percussion": "percussion", "TAB": "tab"}.get (sign.get_text (), None)
+
+    lines = 5
+    details = attributes.get_maybe_exist_named_child ('staff-details')
+    if details:
+        staff_lines = details.get_maybe_exist_named_child ('staff-lines')
+        if staff_lines:
+            lines = string.atoi (staff_lines.get_text ())
+
+    staff = None
+    if clef_sign == "percussion" and lines == 1:
+        staff = musicexp.RhythmicStaff ()
+    elif clef_sign == "percussion":
+        staff = musicexp.DrumStaff ()
+        # staff.drum_style_table = ???
+    elif clef_sign == "tab":
+        staff = musicexp.TabStaff ()
+        staff.string_tunings = staff_attributes_to_string_tunings (attributes)
+        # staff.tablature_format = ???
+    else:
+        # TODO: Handle case with lines <> 5!
+        staff = musicexp.Staff ()
+
+    return staff
+
+
+def extract_score_layout (part_list, staffinfo):
     layout = musicexp.StaffGroup (None)
     if not part_list:
         return layout
@@ -87,7 +279,11 @@ def extract_score_layout (part_list):
     def read_score_part (el):
         if not isinstance (el, musicxml.Score_part):
             return
-        staff = musicexp.Staff ()
+        # Depending on the attributes of the first measure, we create different
+        # types of staves (Staff, RhythmicStaff, DrumStaff, TabStaff, etc.)
+        staff = staff_attributes_to_lily_staff (staffinfo.get (el.id, None))
+        if not staff:
+            return None
         staff.id = el.id
         partname = el.get_maybe_exist_named_child ('part-name')
         # Finale gives unnamed parts the name "MusicXML Part" automatically!
@@ -132,7 +328,9 @@ def extract_score_layout (part_list):
             if not group_info.is_empty ():
                 staves.append (group_info)
                 group_info = PartGroupInfo ()
-            staves.append (read_score_part (el))
+            staff = read_score_part (el)
+            if staff:
+                staves.append (staff)
         elif isinstance (el, musicxml.Part_group):
             if el.type == "start":
                 group_info.add_start (el)
@@ -557,21 +755,21 @@ def musicxml_spanner_to_lily_event (mxl_event):
     return ev
 
 def musicxml_direction_to_indicator (direction):
-    return { "above": 1, "upright": 1, "below": -1, "downright": -1 }.get (direction, '')
+    return { "above": 1, "upright": 1, "up":1, "below": -1, "downright": -1, "down": -1 }.get (direction, 0)
 
 def musicxml_fermata_to_lily_event (mxl_event):
     ev = musicexp.ArticulationEvent ()
     ev.type = "fermata"
     if hasattr (mxl_event, 'type'):
       dir = musicxml_direction_to_indicator (mxl_event.type)
-      if dir:
+      if dir and options.convert_directions:
         ev.force_direction = dir
     return ev
 
 
 def musicxml_arpeggiate_to_lily_event (mxl_event):
     ev = musicexp.ArpeggioEvent ()
-    ev.direction = {"up": 1, "down": -1}.get (getattr (mxl_event, 'direction', None), 0)
+    ev.direction = musicxml_direction_to_indicator (getattr (mxl_event, 'direction', None))
     return ev
 
 
@@ -591,6 +789,12 @@ def musicxml_fingering_event (mxl_event):
     ev.type = mxl_event.get_text ()
     return ev
 
+def musicxml_snappizzicato_event (mxl_event):
+    needed_additional_definitions.append ("snappizzicato")
+    ev = musicexp.MarkupEvent ()
+    ev.contents = "\\snappizzicato"
+    return ev
+
 def musicxml_string_event (mxl_event):
     ev = musicexp.NoDirectionArticulationEvent ()
     ev.type = mxl_event.get_text ()
@@ -652,7 +856,7 @@ articulations_dict = {
     #"schleifer": "?",
     #"scoop": "",
     #"shake": "?",
-    #"snap-pizzicato": "",
+    "snap-pizzicato": musicxml_snappizzicato_event,
     #"spiccato": "",
     "staccatissimo": (musicexp.ShortArticulationEvent, "|"), # or "staccatissimo"
     "staccato": (musicexp.ShortArticulationEvent, "."), # or "staccato"
@@ -694,10 +898,12 @@ def musicxml_articulation_to_lily_event (mxl_event):
 
     # Some articulations use the type attribute, other the placement...
     dir = None
-    if hasattr (mxl_event, 'type'):
+    if hasattr (mxl_event, 'type') and options.convert_directions:
         dir = musicxml_direction_to_indicator (mxl_event.type)
-    if hasattr (mxl_event, 'placement'):
+    if hasattr (mxl_event, 'placement') and options.convert_directions:
         dir = musicxml_direction_to_indicator (mxl_event.placement)
+    if dir:
+        ev.force_direction = dir
     return ev
 
 
@@ -736,7 +942,7 @@ def musicxml_words_to_lily_event (words):
     text = re.sub (' *\n? *$', '', text)
     event.text = text
 
-    if hasattr (words, 'default-y'):
+    if hasattr (words, 'default-y') and options.convert_directions:
         offset = getattr (words, 'default-y')
         try:
             off = string.atoi (offset)
@@ -1039,9 +1245,9 @@ def musicxml_voice_to_lily_voice (voice):
 
     current_staff = None
 
-    # TODO: Make sure that the keys in the dict don't get reordered, since
-    #       we need the correct ordering of the lyrics stanzas! By default,
-    #       a dict will reorder its keys
+    # Make sure that the keys in the dict don't get reordered, since
+    # we need the correct ordering of the lyrics stanzas! By default,
+    # a dict will reorder its keys
     return_value.lyrics_order = voice.get_lyrics_numbers ()
     for k in return_value.lyrics_order:
         lyrics[k] = []
@@ -1364,20 +1570,22 @@ def voices_in_part (part):
     """Return a Name -> Voice dictionary for PART"""
     part.interpret ()
     part.extract_voices ()
-    voice_dict = part.get_voices ()
+    voices = part.get_voices ()
+    part_info = part.get_staff_attributes ()
 
-    return voice_dict
+    return (voices, part_info)
 
 def voices_in_part_in_parts (parts):
     """return a Part -> Name -> Voice dictionary"""
-    return dict([(p, voices_in_part (p)) for p in parts])
+    return dict([(p.id, voices_in_part (p)) for p in parts])
 
 
 def get_all_voices (parts):
     all_voices = voices_in_part_in_parts (parts)
 
     all_ly_voices = {}
-    for p, name_voice in all_voices.items ():
+    all_ly_staffinfo = {}
+    for p, (name_voice, staff_info) in all_voices.items ():
 
         part_ly_voices = {}
         for n, v in name_voice.items ():
@@ -1386,8 +1594,9 @@ def get_all_voices (parts):
             part_ly_voices[n] = musicxml_voice_to_lily_voice (v)
 
         all_ly_voices[p] = part_ly_voices
-        
-    return all_ly_voices
+        all_ly_staffinfo[p] = staff_info
+
+    return (all_ly_voices, all_ly_staffinfo)
 
 
 def option_parser ():
@@ -1414,7 +1623,17 @@ Copyright (c) 2005--2007 by
                   default=False,
                   dest="use_lxml",
                   help=_ ("Use lxml.etree; uses less memory and cpu time."))
-    
+
+    p.add_option ('-l', '--language',
+                  action = "store",
+                  help = _ ("Use a different language file, e.g. 'deutsch' for deutsch.ly."))
+
+    p.add_option ('--no-articulation-directions', '--nd',
+                  action = "store_false",
+                  default = True,
+                  dest = "convert_directions",
+                  help = _ ("Do not convert directions (^, _ or -) for articulations."))
+
     p.add_option ('-o', '--output',
                   metavar=_ ("FILE"),
                   action="store",
@@ -1428,35 +1647,30 @@ Copyright (c) 2005--2007 by
                                      '''?group=gmane.comp.gnu.lilypond.bugs\n'''))
     return p
 
-def music_xml_voice_name_to_lily_name (part, name):
-    str = "Part%sVoice%s" % (part.id, name)
+def music_xml_voice_name_to_lily_name (part_id, name):
+    str = "Part%sVoice%s" % (part_id, name)
     return musicxml_id_to_lily (str) 
 
-def music_xml_lyrics_name_to_lily_name (part, name, lyricsnr):
-    str = "Part%sVoice%sLyrics%s" % (part.id, name, lyricsnr)
+def music_xml_lyrics_name_to_lily_name (part_id, name, lyricsnr):
+    str = "Part%sVoice%sLyrics%s" % (part_id, name, lyricsnr)
     return musicxml_id_to_lily (str) 
 
 def print_voice_definitions (printer, part_list, voices):
-    part_dict={}
-    for (part, nv_dict) in voices.items():
-        part_dict[part.id] = (part, nv_dict)
-
     for part in part_list:
-        (p, nv_dict) = part_dict.get (part.id, (None, {}))
-        #for (name, ((voice, lyrics), mxlvoice)) in nv_dict.items ():
+        part_id = part.id
+        nv_dict = voices.get (part_id, {})
         for (name, voice) in nv_dict.items ():
-            k = music_xml_voice_name_to_lily_name (p, name)
+            k = music_xml_voice_name_to_lily_name (part_id, name)
             printer.dump ('%s = ' % k)
             voice.ly_voice.print_ly (printer)
             printer.newline()
-
             for l in voice.lyrics_order:
-                lname = music_xml_lyrics_name_to_lily_name (p, name, l)
+                lname = music_xml_lyrics_name_to_lily_name (part_id, name, l)
                 printer.dump ('%s = ' %lname )
                 voice.lyrics_dict[l].print_ly (printer)
                 printer.newline()
 
-            
+
 def uniq_list (l):
     return dict ([(elt,1) for elt in l]).keys ()
 
@@ -1469,27 +1683,24 @@ def uniq_list (l):
 #         ]
 #     ]
 # raw_voices is of the form [(voicename, lyricsids)*]
-def format_staff_info (part, staff_id, raw_voices):
+def format_staff_info (part_id, staff_id, raw_voices):
     voices = []
     for (v, lyricsids) in raw_voices:
-        voice_name = music_xml_voice_name_to_lily_name (part, v)
-        voice_lyrics = [music_xml_lyrics_name_to_lily_name (part, v, l)
+        voice_name = music_xml_voice_name_to_lily_name (part_id, v)
+        voice_lyrics = [music_xml_lyrics_name_to_lily_name (part_id, v, l)
                    for l in lyricsids]
         voices.append ([voice_name, voice_lyrics])
     return [staff_id, voices]
 
 def update_score_setup (score_structure, part_list, voices):
-    part_dict = dict ([(p.id, p) for p in voices.keys ()])
-    final_part_dict = {}
 
     for part_definition in part_list:
-        part_name = part_definition.id
-        part = part_dict.get (part_name)
-        if not part:
-            error_message ('unknown part in part-list: %s' % part_name)
+        part_id = part_definition.id
+        nv_dict = voices.get (part_id)
+        if not nv_dict:
+            error_message ('unknown part in part-list: %s' % part_id)
             continue
 
-        nv_dict = voices.get (part)
         staves = reduce (lambda x,y: x+ y,
                 [voice.voicedata._staves.keys ()
                  for voice in nv_dict.values ()],
@@ -1503,17 +1714,27 @@ def update_score_setup (score_structure, part_list, voices):
                 thisstaff_raw_voices = [(voice_name, voice.lyrics_order) 
                     for (voice_name, voice) in nv_dict.items ()
                     if voice.voicedata._start_staff == s]
-                staves_info.append (format_staff_info (part, s, thisstaff_raw_voices))
+                staves_info.append (format_staff_info (part_id, s, thisstaff_raw_voices))
         else:
             thisstaff_raw_voices = [(voice_name, voice.lyrics_order) 
                 for (voice_name, voice) in nv_dict.items ()]
-            staves_info.append (format_staff_info (part, None, thisstaff_raw_voices))
-        score_structure.set_part_information (part_name, staves_info)
+            staves_info.append (format_staff_info (part_id, None, thisstaff_raw_voices))
+        score_structure.set_part_information (part_id, staves_info)
 
 def print_ly_preamble (printer, filename):
     printer.dump_version ()
     printer.print_verbatim ('%% automatically converted from %s\n' % filename)
 
+def print_ly_additional_definitions (printer, filename):
+    if needed_additional_definitions:
+        printer.newline ()
+        printer.print_verbatim ('%% additional definitions required by the score:')
+        printer.newline ()
+    for a in set(needed_additional_definitions):
+        printer.print_verbatim (additional_definitions.get (a, ''))
+    printer.newline ()
+
+
 def read_musicxml (filename, use_lxml):
     if use_lxml:
         import lxml.etree
@@ -1535,17 +1756,18 @@ def convert (filename, options):
     progress ("Reading MusicXML from %s ..." % filename)
     
     tree = read_musicxml (filename, options.use_lxml)
+    parts = tree.get_typed_children (musicxml.Part)
+    (voices, staff_info) = get_all_voices (parts)
 
     score_structure = None
     mxl_pl = tree.get_maybe_exist_typed_child (musicxml.Part_list)
     if mxl_pl:
-        score_structure = extract_score_layout (mxl_pl)
+        score_structure = extract_score_layout (mxl_pl, staff_info)
         part_list = mxl_pl.get_named_children ("score-part")
 
     # score information is contained in the <work>, <identification> or <movement-title> tags
     score_information = extract_score_information (tree)
-    parts = tree.get_typed_children (musicxml.Part)
-    voices = get_all_voices (parts)
+    layout_information = extract_layout_information (tree)
     update_score_setup (score_structure, part_list, voices)
 
     if not options.output_name:
@@ -1563,7 +1785,11 @@ def convert (filename, options):
     printer.set_file (codecs.open (defs_ly_name, 'wb', encoding='utf-8'))
 
     print_ly_preamble (printer, filename)
-    score_information.print_ly (printer)
+    print_ly_additional_definitions (printer, filename)
+    if score_information:
+        score_information.print_ly (printer)
+    if layout_information:
+        layout_information.print_ly (printer)
     print_voice_definitions (printer, part_list, voices)
     
     printer.close ()
@@ -1593,11 +1819,17 @@ def get_existing_filename_with_extension (filename, ext):
 def main ():
     opt_parser = option_parser()
 
+    global options
     (options, args) = opt_parser.parse_args ()
     if not args:
         opt_parser.print_usage()
         sys.exit (2)
-    
+
+    if options.language:
+        musicexp.set_pitch_language (options.language)
+        needed_additional_definitions.append (options.language)
+        additional_definitions[options.language] = "\\include \"%s.ly\"\n" % options.language
+
     # Allow the user to leave out the .xml or xml on the filename
     filename = get_existing_filename_with_extension (args[0], "xml")
     if filename and os.path.exists (filename):