]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/midi2ly.py
* scripts/etf2ly.py (do_options): use optparse
[lilypond.git] / scripts / midi2ly.py
index 654062863281faeacad80481ae6eaec6a3ed4e85..31ce07caaa580a4dd99842b3e10019173bc256ce 100644 (file)
@@ -1,17 +1,16 @@
 #!@PYTHON@
 #
-# midi2ly.py -- LilyPond midi import script
+# msdi2ly.py -- LilyPond midi import script
 # 
 # source file of the GNU LilyPond music typesetter
 #
-# convert MIDI to LilyPond source
-#
+# (c) 1998--2006  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+#                 Jan Nieuwenhuizen <janneke@gnu.org>
 
 
 '''
 TODO:
    * test on weird and unquantised midi input (lily-devel)
-   * drop c++ midi2ly
    * update doc and manpage
 
    * simply insert clef changes whenever too many ledger lines
@@ -22,28 +21,68 @@ TODO:
      other converters, while leaving midi specific stuff here
 '''
 
+import getopt
 import os
+import string
 import sys
 
-# if set, LILYPONDPREFIX must take prevalence
-# if datadir is not set, we're doing a build and LILYPONDPREFIX 
-datadir = '@datadir@'
-if os.environ.has_key ('LILYPONDPREFIX') \
-   or '@datadir@' == '@' + 'datadir' + '@':
+       
+################################################################
+# Users of python modules should include this snippet.
+#
+libdir = '@local_lilypond_libdir@'
+if not os.path.isdir (libdir):
+        libdir = '@lilypond_libdir@'
+
+# ugh
+datadir = '@local_lilypond_datadir@'
+if os.environ.has_key ('LILYPONDPREFIX'):
        datadir = os.environ['LILYPONDPREFIX']
-else:
-       datadir = '@datadir@'
+       while datadir[-1] == os.sep:
+               datadir= datadir[:-1]
+       libdir = datadir.replace ('/share/', '/lib/')
+
+if os.path.exists (os.path.join (datadir, 'lib/lilypond/@TOPLEVEL_VERSION@/')):
+       libdir = os.path.join (libdir, 'lib/lilypond/@TOPLEVEL_VERSION@/')
+        
+if os.path.exists (os.path.join (datadir, 'lib/lilypond/current/')):
+       libdir = os.path.join (libdir, 'lib/lilypond/current/')
+        
+sys.path.insert (0, os.path.join (libdir, 'python'))
+
+# dynamic relocation, for GUB binaries.
+bindir = os.path.split (sys.argv[0])[0]
+for p in ['share', 'lib']:
+       datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % p)
+       sys.path.insert (0, datadir)
+
+################################################################
 
-sys.path.append (os.path.join (datadir, 'python'))
-sys.path.append (os.path.join (datadir, 'python/out'))
+import midi
+import lilylib as ly
 
+################################################################
+################ CONSTANTS
+
+
+output_name = ''
+LINE_BELL = 60
+scale_steps = [0,2,4,5,7,9,11]
+global_options = None
+
+
+clocks_per_1 = 1536
+clocks_per_4 = 0
+
+time = 0
+reference_note = 0
+start_quant_clocks = 0
+
+duration_quant_clocks = 0
+allowed_tuplet_clocks = []
 
-import getopt
-import __main__
-import sys
-import string
-import midi
 
+################################################################
 
 localedir = '@localedir@'
 try:
@@ -55,37 +94,49 @@ except:
        def _ (s):
                return s
 
-program_name = 'midi2ly'
+program_name = sys.argv[0]
 program_version = '@TOPLEVEL_VERSION@'
 
 errorport = sys.stderr
-verbose_p = 0
 
-# temp_dir = os.path.join (original_dir,  '%s.dir' % program_name)
-# original_dir = os.getcwd ()
-# keep_temp_dir_p = 0
+def identify ():
+       sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
 
+def warranty ():
+       identify ()
+       sys.stdout.write ('''
+Copyright (c) %s by
 
-help_summary = _ ("Convert MIDI to LilyPond source")
+  Han-Wen Nienhuys
+  Jan Nieuwenhuizen
 
-option_definitions = [
-       ('', 'a', 'absolute-pitches', _ ("print absolute pitches")),
-       (_ ("DUR"), 'd', 'duration-quant', _ ("quantise note durations on DUR")),
-       ('', 'e', 'explicit-durations', _ ("print explicit durations")),
-       ('', 'h', 'help', _ ("this help")),
-       (_ ("ALT[:MINOR]"), 'k', 'key', _ ("set key: ALT=+sharps|-flats; MINOR=1")),
-       (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
-       (_ ("DUR"), 's', 'start-quant', _ ("quantise note starts on DUR")),
-       (_ ("DUR*NUM/DEN"), 't', 'allow-tuplet', _ ("allow tuplet durations DUR*NUM/DEN")),
-       ('', 'V', 'verbose', _ ("verbose")),
-       ('', 'v', 'version', _ ("print version number")),
-       ('', 'w', 'warranty', _ ("show warranty and copyright")),
-       ('', 'x', 'text-lyrics', _ ("treat every text as a lyric")),
-       ]
+%s
+%s
+'''  ( '2001--2006',
+       _('Distributed under terms of the GNU General Public License.'),
+       _('It comes with NO WARRANTY.'))
 
-# from lilylib import *
-import lilylib
 
+def progress (s):
+       errorport.write (s + '\n')
+
+def warning (s):
+       progress (_ ("warning: ") + s)
+               
+def error (s):
+       progress (_ ("error: ") + s)
+       raise _ ("Exiting ... ")
+
+def system (cmd, ignore_error = 0):
+       return ly.system (cmd, ignore_error=ignore_error)
+
+def strip_extension (f, ext):
+       (p, e) = os.path.splitext (f)
+       if e == ext:
+               e = ''
+       return p + e
+
+\f
 
 
 class Duration:
@@ -99,7 +150,7 @@ class Duration:
        def dur_num_den (self, clocks):
                for i in range (len (allowed_tuplet_clocks)):
                        if clocks == allowed_tuplet_clocks[i]:
-                               return allowed_tuplets[i]
+                               return global_options.allowed_tuplets[i]
 
                dur = 0; num = 1; den = 1;
                g = gcd (clocks, clocks_per_1)
@@ -138,7 +189,6 @@ class Note:
        names = (0, 0, 1, 1, 2, 3, 3, 4, 4, 5, 5, 6)
        alterations = (0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0)
        alteration_names = ('eses', 'es', '', 'is' , 'isis')
-       
        def __init__ (self, clocks, pitch, velocity):
                self.pitch = pitch
                self.velocity = velocity
@@ -154,7 +204,7 @@ class Note:
                n = self.names[(self.pitch) % 12]
                a = self.alterations[(self.pitch) % 12]
 
-               if a and key.flats:
+               if a and global_options.key.flats:
                        a = - self.alterations[(self.pitch) % 12]
                        n = (n - a) % 7
 
@@ -186,6 +236,7 @@ class Note:
 
                o = self.pitch / 12 - 4
 
+               key = global_options.key
                if key.minor:
                        # as -> gis
                        if key.sharps == 0 and key.flats == 0 \
@@ -223,10 +274,15 @@ class Note:
 
                return (o, n, a)
                
-       def dump (self):
+        def __repr__ (self):
+               s = chr ((self.notename + 2)  % 7 + ord ('a'))
+                return 'Note(%s %s)' % (s, self.duration.dump())
+
+       def dump (self, dump_dur = 1):
+               global reference_note
                s = chr ((self.notename + 2)  % 7 + ord ('a'))
                s = s + self.alteration_names[self.alteration + 2]
-               if absolute_p:
+               if global_options.absolute_pitches:
                        commas = self.octave
                else:
                        delta = self.pitch - reference_note.pitch
@@ -243,12 +299,14 @@ class Note:
                elif commas < 0:
                        s = s + "," * -commas
 
-               if explicit_durations_p \
-                  or Duration.compare (self.duration, reference_note.duration):
+               ## FIXME: compile fix --jcn
+               if dump_dur and (global_options.explicit_durations \
+                  or Duration.compare (self.duration,
+                                       reference_note.duration)):
                        s = s + self.duration.dump ()
 
-               global reference_note
                reference_note = self
+               
                # TODO: move space
                return s + ' '
 
@@ -261,7 +319,10 @@ class Time:
 
        def bar_clocks (self):
                return clocks_per_1 * self.num / self.den
-       
+
+        def __repr__ (self):
+                return 'Time(%d/%d)' % (self.num, self.den)
+        
        def dump (self):
                global time
                time = self
@@ -272,14 +333,23 @@ class Tempo:
                self.clocks = 0
                self.seconds_per_1 = seconds_per_1
 
+        def __repr__ (self):
+                return 'Tempo(%d)' % self.bpm ()
+        
+        def bpm (self):
+                return 4 * 60 / self.seconds_per_1
+        
        def dump (self):
-               return '\n  ' + '\\tempo 4 = %d ' % (4 * 60 / self.seconds_per_1) + '\n  '
+               return '\n  ' + '\\tempo 4 = %d ' % (self.bpm()) + '\n  '
 
 class Clef:
        clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
        def __init__ (self, type):
                self.type = type
-               
+
+       def __repr__ (self):
+                return 'Clef(%s)' % self.clefs[self.type]
+        
        def dump (self):
                return '\n  \\clef %s\n  ' % self.clefs[self.type]
 
@@ -299,10 +369,9 @@ class Key:
 
                s = ''
                if self.sharps and self.flats:
-                       s = '\\keysignature %s ' % 'TODO'
+                        pass
                else:
-                       
-                       if self.flats:
+                        if self.flats:
                                k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
                        else:
                                k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
@@ -357,7 +426,7 @@ class Text:
                if self.type == midi.LYRIC:
                        s = '"%s"' % self.text
                        d = Duration (self.clocks)
-                       if explicit_durations_p \
+                       if global_options.explicit_durations \
                           or Duration.compare (d,
                                                reference_note.duration):
                                s = s + Duration (self.clocks).dump ()
@@ -366,25 +435,10 @@ class Text:
                        s = '\n  % [' + self.text_types[self.type] + '] ' + self.text + '\n  '
                return s
 
+        def __repr__ (self):
+                return 'Text(%d=%s)' % (self.type, self.text)
 
-output_name = ''
-LINE_BELL = 60
-scale_steps = [0,2,4,5,7,9,11]
 
-clocks_per_1 = 1536
-clocks_per_4 = 0
-key = 0
-time = 0
-reference_note = 0
-start_quant = 0
-start_quant_clocks = 0
-duration_quant = 0
-duration_quant_clocks = 0
-allowed_tuplets = []
-allowed_tuplet_clocks = []
-absolute_p = 0
-explicit_durations_p = 0
-text_lyrics_p = 0
 
 def split_track (track):
        chs = {}
@@ -508,7 +562,7 @@ def events_on_channel (channel):
                                key = k
 
                        elif e[1][1] == midi.LYRIC \
-                            or (text_lyrics_p and e[1][1] == midi.TEXT_EVENT):
+                            or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT):
                                if last_lyric:
                                        last_lyric.clocks = t - last_time
                                        events.append ((last_time, last_lyric))
@@ -519,11 +573,11 @@ def events_on_channel (channel):
                             and e[1][1] <= midi.CUE_POINT:
                                events.append ((t, Text (e[1][1], e[1][2])))
                        else:
-                               if verbose_p:
+                               if global_options.verbose:
                                        sys.stderr.write ("SKIP: %s\n" % `e`)
                                pass
                else:
-                       if verbose_p:
+                       if global_options.verbose:
                                sys.stderr.write ("SKIP: %s\n" % `e`)
                        pass
 
@@ -600,11 +654,13 @@ def dump_chord (ch):
        elif len (notes) > 1:
                global reference_note
                s = s + '<'
-               s = s + notes[0].dump ()
+               s = s + notes[0].dump (dump_dur = 0)
                r = reference_note
                for i in notes[1:]:
-                       s = s + i.dump ()
+                       s = s + i.dump (dump_dur = 0 )
                s = s + '>'
+
+               s = s + notes[0].duration.dump() + ' '
                reference_note = r
        return s
 
@@ -704,21 +760,20 @@ def dump_track (channels, n):
 
                if item and item.__class__ == Note:
                        skip = 's'
-                       s = s + '%s = \\notes' % (track + channel)
-                       if not absolute_p:
+                       s = s + '%s = ' % (track + channel)
+                       if not global_options.absolute_pitches:
                                s = s + '\\relative c '
                elif item and item.__class__ == Text:
                        skip = '" "'
-                       s = s + '%s = \\lyrics ' % (track + channel)
+                       s = s + '%s = \\lyricmode ' % (track + channel)
                else:
                        skip = '\\skip '
-                       # must be in \notes mode for parsing \skip
-                       s = s + '%s = \\notes ' % (track + channel)
+                       s = s + '%s =  ' % (track + channel)
                s = s + '{\n'
                s = s + '  ' + dump_channel (channels[i][0], skip)
                s = s + '}\n\n'
 
-       s = s + '%s = <\n' % track
+       s = s + '%s = <<\n' % track
 
        if clef.type != 2:
                s = s + clef.dump () + '\n'
@@ -732,21 +787,25 @@ def dump_track (channels, n):
                else:
                        s = s + '  \\context Voice = %s \\%s\n' % (channel,
                                                                   track + channel)
-       s = s + '>\n\n'
+       s = s + '>>\n\n'
        return s
 
 def thread_first_item (thread):
        for chord in thread:
                for event in chord:
-                       if event[1].__class__ == Note \
-                          or (event[1].__class__ == Text \
-                              and event[1].type == midi.LYRIC):
-                               return event[1]
-       return 0
+                       if (event[1].__class__ == Note 
+                            or (event[1].__class__ == Text 
+                                and event[1].type == midi.LYRIC)):
+                                
+                            return event[1]
+       return None
 
 def track_first_item (track):
        for thread in track:
-               return thread_first_item (thread)
+               first = thread_first_item (thread)
+                if first:
+                        return first
+        return None
 
 def guess_clef (track):
        i = 0
@@ -767,26 +826,26 @@ def guess_clef (track):
                return Clef (2)
        
 
-def convert_midi (f, o):
+def convert_midi (in_file, out_file):
        global clocks_per_1, clocks_per_4, key
+       global start_quant_clocks
+       global  duration_quant_clocks
+       global allowed_tuplet_clocks
 
-       str = open (f).read ()
+       str = open (in_file).read ()
        midi_dump = midi.parse (str)
-
+        
        clocks_per_1 = midi_dump[0][1]
        clocks_per_4 = clocks_per_1 / 4
        
-       global start_quant, start_quant_clocks
-       if start_quant:
-               start_quant_clocks = clocks_per_1 / start_quant
+       if global_options.start_quant:
+               start_quant_clocks = clocks_per_1 / global_options.start_quant
 
-       global duration_quant, duration_quant_clocks
-       if duration_quant:
-               duration_quant_clocks = clocks_per_1 / duration_quant
+       if global_options.duration_quant:
+               duration_quant_clocks = clocks_per_1 / global_options.duration_quant
 
-       global allowed_tuplet_clocks
        allowed_tuplet_clocks = []
-       for (dur, num, den) in allowed_tuplets:
+       for (dur, num, den) in global_options.allowed_tuplets:
                allowed_tuplet_clocks.append (clocks_per_1 * num / (dur * den))
 
        tracks = []
@@ -796,118 +855,136 @@ def convert_midi (f, o):
 
        tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, f)
 
+        
        s = ''
-       s = tag + '\n\n'
+       s = tag + '\n\\version "2.7.18"\n\n'
        for i in range (len (tracks)):
                s = s + dump_track (tracks[i], i)
 
-       s = s + '\n\\score {\n  <\n'
-       for i in range (len (tracks)):
+       s = s + '\n\\score {\n  <<\n'
+        
+        i = 0
+       for t in tracks:
                track = track_name (i)
-               item = track_first_item (tracks[i])
+               item = track_first_item (t)
+                
                if item and item.__class__ == Note:
                        s = s + '    \\context Staff=%s \\%s\n' % (track, track)
                elif item and item.__class__ == Text:
                        s = s + '    \\context Lyrics=%s \\%s\n' % (track, track)
-       s = s + '  >\n}\n'
 
-       lilylib.progress (_ ("%s output to `%s'...") % ('LY', o))
+                i += 1
+       s = s + '  >>\n}\n'
+
+       progress (_ ("%s output to `%s'...") % ('LY', o))
 
        if o == '-':
-               h = sys.stdout
+               handle = sys.stdout
        else:
-               h = open (o, 'w')
+               handle = open (out_file, 'w')
+
+       handle.write (s)
+       handle.close ()
+
+
+def get_option_parser ():
+       p = ly.get_option_parser (usage='midi2ly [OPTIONS] FILE',
+                                 version="midi2ly (LilyPond) @TOPLEVEL_VERSION@",
+                                 description=_('''Convert MIDI to LilyPond source.'''))
+
+       p.add_option ('-a', '--absolute-pitches',
+                     action='store_true',
+                     help=_ ("print absolute pitches"))
+       p.add_option ('-d', '--duration-quant',
+                     metavar= _("DUR"),
+                     help=_("quantise note durations on DUR"))
+       p.add_option ('-e', '--explicit-durations',
+                     action='store_true',
+                     help=_ ("print explicit durations"))
+       p.add_option('-k', '--key', help=_ ("set key: ALT=+sharps|-flats; MINOR=1"),
+                    metavar=_ ("ALT[:MINOR]"),
+                    default='0'),
+       p.add_option ('-o', '--output', help=_("write output to FILE"),
+                     metavar=_("FILE"),
+                     action='store')
+       p.add_option ('-s', '--start-quant',help= _ ("quantise note starts on DUR"),
+                     metavar=_ ("DUR"))
+       p.add_option ('-t', '--allow-tuplet',
+                     metavar=_ ("DUR*NUM/DEN"),
+                     action = "append",
+                     dest="allowed_tuplets",
+                     help=_ ("allow tuplet durations DUR*NUM/DEN"),
+                     default=[])
+       p.add_option ('-V', '--verbose', help=_ ("be verbose"),
+                     action='store_true',
+                     ),
+       p.add_option ('-w', '--warranty', help=_ ("show warranty"),
+                     action='store_true',
+                     ),
+       p.add_option ('-x', '--text-lyrics', help=_("treat every text as a lyric"),
+                     action='store_true')
+
+       p.add_option_group (_ ("example"),
+                           description = r'''
+    midi2ly --key=-2:1 --duration-quant=32 \
+        --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
+''')
+       
+       p.add_option_group  ('bugs',
+                            description='''Report bugs via http://post.gmane.org/post.php'''
+                            '''?group=gmane.comp.gnu.lilypond.bugs\n''')
+       
+       return p
 
-       h.write (s)
-       h.close ()
 
 
-(sh, long) = lilylib.getopt_args (option_definitions)
-try:
-       (options, files) = getopt.getopt(sys.argv[1:], sh, long)
-except getopt.error, s:
-       errorport.write ('\n')
-       errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
-       errorport.write ('\n')
-       errorport.write ('\n')
-       lilylib.help ()
-       sys.exit (2)
-       
-for opt in options:    
-       o = opt[0]
-       a = opt[1]
+def do_options ():
+       opt_parser = get_option_parser()
+       (options, args) = opt_parser.parse_args ()
 
-       if 0:
-               pass
-       elif o == '--help' or o == '-h':
-               lilylib.help ()
-               errorport.write ('\n')
-               errorport.write (_ ("Example:"))
-               errorport.write  (r'''
-    midi2ly --key=-2:1 --duration-quant=32 \
-        --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
-''')
-               sys.exit (0)
-       elif o == '--output' or o == '-o':
-               output_name = a
-       elif o == '--verbose' or o == '-V':
-               verbose_p = 1
-       elif o == '--version' or o == '-v':
-               lilylib.identify ()
-               sys.exit (0)
-       elif o == '--warranty' or o == '-w':
-               status = system ('lilypond -w', ignore_error = 1)
-               if status:
-                       warranty ()
-               sys.exit (0)
+       if not args or args[0] == '-':
+               opt_parser.print_help ()
+               sys.stderr.write ('\n%s: %s %s\n' % (program_name, _ ("error: "),
+                                                    _ ("no files specified on command line.")))
+               sys.exit (2)
 
+       if options.duration_quant:
+               options.duration_quant = string.atoi (options.duration_quant)
 
-       elif o == '--absolute-pitches' or o == '-a':
-               global absolute_p
-               absolute_p = 1
-       elif o == '--duration-quant' or o == '-d':
-               global duration_quant
-               duration_quant = string.atoi (a)
-       elif o == '--explicit-durations' or o == '-e':
-               global explicit_durations_p
-               explicit_durations_p = 1
-       elif o == '--key' or o == '-k':
-               (alterations, minor) = map (string.atoi, string.split (a + ':0', ':'))[0:2]
+       if options.warranty:
+               warranty ()
+               sys.exit (0)
+       if 1:
+               (alterations, minor) = map (string.atoi, string.split (options.key + ':0', ':'))[0:2]
                sharps = 0
                flats = 0
                if alterations >= 0:
                        sharps = alterations
                else:
                        flats = - alterations
-               global key
-               key = Key (sharps, flats, minor)
-       elif o == '--start-quant' or o == '-s':
-               global start_quant, start_quant_clocks
-               start_quant = string.atoi (a)
-       elif o == '--allow-tuplet' or o == '-t':
-               global allowed_tuplets
-               a = string.replace (a, '/', '*')
-               tuplet = map (string.atoi, string.split (a, '*'))
-               allowed_tuplets.append (tuplet)
-       # lots of midi files use plain text for lyric events
-       elif o == '--text-lyrics' or o == '-x':
-               text_lyrics_p = 1
 
+               options.key = Key (sharps, flats, minor)
+
+               
+       if options.start_quant:
+               options.start_quant = string.atoi (a)
+               
+       options.allowed_tuplets = [map (string.atoi, a.replace ('/','*').split ('*'))
+                               for a in options.allowed_tuplets]
+       
+       global global_options
+       global_options = options
 
-if not files or files[0] == '-':
+       return args
 
-       # FIXME: read from stdin when files[0] = '-'
-       lilylib.help ()
-       errorport.write (program_name + ":" + _ ("error: ") + _ ("no files specified on command line.") + '\n')
-       sys.exit (2)
 
+files = do_options()
 
 for f in files:
-
        g = f
-       g = lilylib.strip_extension (g, '.midi')
-       g = lilylib.strip_extension (g, '.mid')
-       g = lilylib.strip_extension (g, '.MID')
+       g = strip_extension (g, '.midi')
+       g = strip_extension (g, '.mid')
+       g = strip_extension (g, '.MID')
        (outdir, outbase) = ('','')
 
        if not output_name:
@@ -922,8 +999,11 @@ for f in files:
                o = output_name
                (outdir, outbase) = os.path.split (o)
 
-       if outdir != '.':
-               mkdir_p (outdir, 0777)
+       if outdir != '.' and outdir != '':
+               try:
+                       os.mkdir (outdir, 0777)
+               except OSError:
+                       pass
 
        convert_midi (f, o)