]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/midi2ly.py
*** empty log message ***
[lilypond.git] / scripts / midi2ly.py
index 654062863281faeacad80481ae6eaec6a3ed4e85..29bb128f45713bd0d3daf82413d4aff043daeaa1 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--2005  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,29 +21,66 @@ 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
+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/')
 
-sys.path.append (os.path.join (datadir, 'python'))
-sys.path.append (os.path.join (datadir, 'python/out'))
+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'))
 
+################################################################
 
-import getopt
-import __main__
-import sys
-import string
 import midi
 
 
+################################################################
+################ CONSTANTS
+
+
+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
+
+
+
+################################################################
+
 localedir = '@localedir@'
 try:
        import gettext
@@ -55,7 +91,7 @@ except:
        def _ (s):
                return s
 
-program_name = 'midi2ly'
+program_name = sys.argv[0]
 program_version = '@TOPLEVEL_VERSION@'
 
 errorport = sys.stderr
@@ -66,27 +102,204 @@ verbose_p = 0
 # keep_temp_dir_p = 0
 
 
-help_summary = _ ("Convert MIDI to LilyPond source")
+help_summary = _ ("Convert MIDI to LilyPond source.")
 
 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")),
+       ('', 'h', 'help', _ ("print this help")),
        (_ ("ALT[:MINOR]"), 'k', 'key', _ ("set key: ALT=+sharps|-flats; MINOR=1")),
-       (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
+       (_ ("FILE"), 'o', 'output', _ ("write output 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', 'verbose', _ ("be verbose")),
        ('', 'v', 'version', _ ("print version number")),
        ('', 'w', 'warranty', _ ("show warranty and copyright")),
        ('', 'x', 'text-lyrics', _ ("treat every text as a lyric")),
        ]
 
-# from lilylib import *
-import lilylib
+################################################################
+# lilylib.py -- options and stuff
+# 
+# source file of the GNU LilyPond music typesetter
+
+import os
+
+try:
+       import gettext
+       gettext.bindtextdomain ('lilypond', localedir)
+       gettext.textdomain ('lilypond')
+       _ = gettext.gettext
+except:
+       def _ (s):
+               return s
+
+if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
+       program_version = '1.5.17'
+
+def identify ():
+       sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
+
+def warranty ():
+       identify ()
+       sys.stdout.write ('\n')
+       sys.stdout.write (_ ('Copyright (c) %s by') % ' 2001--2005')
+       sys.stdout.write ('\n')
+       sys.stdout.write ('  Han-Wen Nienhuys')
+       sys.stdout.write ('  Jan Nieuwenhuizen')
+       sys.stdout.write ('\n\n')
+       sys.stdout.write (_ ("Distributed under terms of the GNU General Public License."))
+        sys.stdout.write (_ ("It comes with NO WARRANTY."))
+       sys.stdout.write ('\n')
+
+def progress (s):
+       errorport.write (s + '\n')
+
+def warning (s):
+       progress (_ ("warning: ") + s)
+               
+def error (s):
+
+
+       '''Report the error S.  Exit by raising an exception. Please
+       do not abuse by trying to catch this error. If you do not want
+       a stack trace, write to the output directly.
+
+       RETURN VALUE
+
+       None
+       
+       '''
+       
+       progress (_ ("error: ") + s)
+       raise _ ("Exiting ... ")
+
+def getopt_args (opts):
+       '''Construct arguments (LONG, SHORT) for getopt from  list of options.'''
+       short = ''
+       long = []
+       for o in opts:
+               if o[1]:
+                       short = short + o[1]
+                       if o[0]:
+                               short = short + ':'
+               if o[2]:
+                       l = o[2]
+                       if o[0]:
+                               l = l + '='
+                       long.append (l)
+       return (short, long)
+
+def option_help_str (o):
+       '''Transform one option description (4-tuple ) into neatly formatted string'''
+       sh = '  '       
+       if o[1]:
+               sh = '-%s' % o[1]
+
+       sep = '  '
+       if o[1] and o[2]:
+               sep = ', '
+               
+       long = ''
+       if o[2]:
+               long= '--%s' % o[2]
+
+       arg = ''
+       if o[0]:
+               if o[2]:
+                       arg = '='
+               arg = arg + o[0]
+       return '  ' + sh + sep + long + arg
+
+
+def options_help_str (opts):
+       '''Convert a list of options into a neatly formatted string'''
+       w = 0
+       strs =[]
+       helps = []
+
+       for o in opts:
+               s = option_help_str (o)
+               strs.append ((s, o[3]))
+               if len (s) > w:
+                       w = len (s)
+
+       str = ''
+       for s in strs:
+               str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0])  + 3), s[1])
+       return str
+
+def help ():
+       ls = [(_ ("Usage: %s [OPTIONS]... FILE") % program_name),
+               ('\n\n'),
+               (help_summary),
+               ('\n\n'),
+               (_ ("Options:")),
+               ('\n'),
+               (options_help_str (option_definitions)),
+               ('\n\n'),
+               (_ ("Report bugs via %s.") %
+                "http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs"),
+               ('\n')]
+       map (sys.stdout.write, ls)
+       
+def setup_temp ():
+       """
+       Create a temporary directory, and return its name. 
+       """
+       global temp_dir
+       if not keep_temp_dir_p:
+               temp_dir = tempfile.mktemp (program_name)
+       try:
+               os.mkdir (temp_dir, 0777)
+       except OSError:
+               pass
+
+       return temp_dir
+
+
+def system (cmd, ignore_error = 0):
+       """Run CMD. If IGNORE_ERROR is set, don't complain when CMD returns non zero.
+
+       RETURN VALUE
+
+       Exit status of CMD
+       """
+       
+       if verbose_p:
+               progress (_ ("Invoking `%s\'") % cmd)
+       st = os.system (cmd)
+       if st:
+               name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
+               msg = name + ': ' + _ ("command exited with value %d") % st
+               if ignore_error:
+                       warning (msg + ' ' + _ ("(ignored)") + ' ')
+               else:
+                       error (msg)
+
+       return st
 
 
+def cleanup_temp ():
+       if not keep_temp_dir_p:
+               if verbose_p:
+                       progress (_ ("Cleaning %s...") % temp_dir)
+               shutil.rmtree (temp_dir)
+
+
+def strip_extension (f, ext):
+       (p, e) = os.path.splitext (f)
+       if e == ext:
+               e = ''
+       return p + e
+
+################################################################
+# END Library
+################################################################
+
+\f
+
 
 class Duration:
        allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
@@ -138,7 +351,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
@@ -223,7 +435,12 @@ 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:
@@ -243,12 +460,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 (explicit_durations_p \
+                  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 +480,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 +494,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 +530,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
@@ -366,25 +596,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 = {}
@@ -600,11 +815,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 +921,20 @@ def dump_track (channels, n):
 
                if item and item.__class__ == Note:
                        skip = 's'
-                       s = s + '%s = \\notes' % (track + channel)
+                       s = s + '%s = ' % (track + channel)
                        if not absolute_p:
                                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 +948,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,24 +987,24 @@ 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, start_quant_clocks
+       global duration_quant, 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
 
-       global duration_quant, duration_quant_clocks
        if duration_quant:
                duration_quant_clocks = clocks_per_1 / duration_quant
 
-       global allowed_tuplet_clocks
        allowed_tuplet_clocks = []
        for (dur, num, den) in allowed_tuplets:
                allowed_tuplet_clocks.append (clocks_per_1 * num / (dur * den))
@@ -796,33 +1016,39 @@ 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')
 
-       h.write (s)
-       h.close ()
+       handle.write (s)
+       handle.close ()
 
 
-(sh, long) = lilylib.getopt_args (option_definitions)
+(sh, long) = getopt_args (option_definitions)
 try:
        (options, files) = getopt.getopt(sys.argv[1:], sh, long)
 except getopt.error, s:
@@ -830,7 +1056,7 @@ except getopt.error, s:
        errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
        errorport.write ('\n')
        errorport.write ('\n')
-       lilylib.help ()
+       help ()
        sys.exit (2)
        
 for opt in options:    
@@ -840,7 +1066,7 @@ for opt in options:
        if 0:
                pass
        elif o == '--help' or o == '-h':
-               lilylib.help ()
+               help ()
                errorport.write ('\n')
                errorport.write (_ ("Example:"))
                errorport.write  (r'''
@@ -853,7 +1079,7 @@ for opt in options:
        elif o == '--verbose' or o == '-V':
                verbose_p = 1
        elif o == '--version' or o == '-v':
-               lilylib.identify ()
+               identify ()
                sys.exit (0)
        elif o == '--warranty' or o == '-w':
                status = system ('lilypond -w', ignore_error = 1)
@@ -863,13 +1089,10 @@ for opt in options:
 
 
        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]
@@ -879,13 +1102,10 @@ for opt in options:
                        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)
@@ -897,17 +1117,16 @@ for opt in options:
 if not files or files[0] == '-':
 
        # FIXME: read from stdin when files[0] = '-'
-       lilylib.help ()
+       help ()
        errorport.write (program_name + ":" + _ ("error: ") + _ ("no files specified on command line.") + '\n')
        sys.exit (2)
 
 
 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 +1141,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)