3 # midi2ly.py -- LilyPond midi import script
5 # source file of the GNU LilyPond music typesetter
7 # (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 # Jan Nieuwenhuizen <janneke@gnu.org>
13 * test on weird and unquantised midi input (lily-devel)
15 * update doc and manpage
17 * simply insert clef changes whenever too many ledger lines
18 [to avoid tex capacity exceeded]
19 * do not ever quant skips
20 * better lyrics handling
21 * [see if it is feasible to] move ly-classes to library for use in
22 other converters, while leaving midi specific stuff here
31 ################################################################
32 # Users of python modules should include this snippet.
34 # This soon to be removed for: import lilypond.lilylib as ly
35 libdir = '@local_lilypond_libdir@'
36 if not os.path.isdir (libdir):
37 libdir = '@lilypond_libdir@'
38 sys.path.insert (0, os.path.join (libdir, 'python'))
41 ################################################################
46 ################################################################
47 ################ CONSTANTS
52 scale_steps = [0,2,4,5,7,9,11]
60 start_quant_clocks = 0
62 duration_quant_clocks = 0
64 allowed_tuplet_clocks = []
66 explicit_durations_p = 0
71 ################################################################
73 localedir = '@localedir@'
76 gettext.bindtextdomain ('lilypond', localedir)
77 gettext.textdomain ('lilypond')
83 program_name = sys.argv[0]
84 program_version = '@TOPLEVEL_VERSION@'
86 errorport = sys.stderr
89 # temp_dir = os.path.join (original_dir, '%s.dir' % program_name)
90 # original_dir = os.getcwd ()
94 help_summary = _ ("Convert MIDI to LilyPond source.")
96 option_definitions = [
97 ('', 'a', 'absolute-pitches', _ ("print absolute pitches")),
98 (_ ("DUR"), 'd', 'duration-quant', _ ("quantise note durations on DUR")),
99 ('', 'e', 'explicit-durations', _ ("print explicit durations")),
100 ('', 'h', 'help', _ ("print this help")),
101 (_ ("ALT[:MINOR]"), 'k', 'key', _ ("set key: ALT=+sharps|-flats; MINOR=1")),
102 (_ ("FILE"), 'o', 'output', _ ("write output to FILE")),
103 (_ ("DUR"), 's', 'start-quant', _ ("quantise note starts on DUR")),
104 (_ ("DUR*NUM/DEN"), 't', 'allow-tuplet', _ ("allow tuplet durations DUR*NUM/DEN")),
105 ('', 'V', 'verbose', _ ("be verbose")),
106 ('', 'v', 'version', _ ("print version number")),
107 ('', 'w', 'warranty', _ ("show warranty and copyright")),
108 ('', 'x', 'text-lyrics', _ ("treat every text as a lyric")),
111 ################################################################
112 # lilylib.py -- options and stuff
114 # source file of the GNU LilyPond music typesetter
120 gettext.bindtextdomain ('lilypond', localedir)
121 gettext.textdomain ('lilypond')
127 if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
128 program_version = '1.5.17'
131 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
135 sys.stdout.write ('\n')
136 sys.stdout.write (_ ('Copyright (c) %s by') % ' 2001--2004')
137 sys.stdout.write ('\n')
138 sys.stdout.write (' Han-Wen Nienhuys')
139 sys.stdout.write (' Jan Nieuwenhuizen')
140 sys.stdout.write ('\n\n')
141 sys.stdout.write (_ ("Distributed under terms of the GNU General Public License."))
142 sys.stdout.write (_ ("It comes with NO WARRANTY."))
143 sys.stdout.write ('\n')
146 errorport.write (s + '\n')
149 progress (_ ("warning: ") + s)
154 '''Report the error S. Exit by raising an exception. Please
155 do not abuse by trying to catch this error. If you do not want
156 a stack trace, write to the output directly.
164 progress (_ ("error: ") + s)
165 raise _ ("Exiting ... ")
167 def getopt_args (opts):
168 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
183 def option_help_str (o):
184 '''Transform one option description (4-tuple ) into neatly formatted string'''
202 return ' ' + sh + sep + long + arg
205 def options_help_str (opts):
206 '''Convert a list of options into a neatly formatted string'''
212 s = option_help_str (o)
213 strs.append ((s, o[3]))
219 str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0]) + 3), s[1])
223 ls = [(_ ("Usage: %s [OPTIONS]... FILE") % program_name),
229 (options_help_str (option_definitions)),
231 (_ ("Report bugs to %s.") % 'bug-lilypond@gnu.org'),
233 map (sys.stdout.write, ls)
237 Create a temporary directory, and return its name.
240 if not keep_temp_dir_p:
241 temp_dir = tempfile.mktemp (program_name)
243 os.mkdir (temp_dir, 0777)
250 def system (cmd, ignore_error = 0):
251 """Run CMD. If IGNORE_ERROR is set, don't complain when CMD returns non zero.
259 progress (_ ("Invoking `%s\'") % cmd)
262 name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
263 msg = name + ': ' + _ ("command exited with value %d") % st
265 warning (msg + ' ' + _ ("(ignored)") + ' ')
273 if not keep_temp_dir_p:
275 progress (_ ("Cleaning %s...") % temp_dir)
276 shutil.rmtree (temp_dir)
279 def strip_extension (f, ext):
280 (p, e) = os.path.splitext (f)
285 ################################################################
287 ################################################################
293 allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
294 def __init__ (self, clocks):
297 self.clocks = duration_quant_clocks
298 (self.dur, self.num, self.den) = self.dur_num_den (clocks)
300 def dur_num_den (self, clocks):
301 for i in range (len (allowed_tuplet_clocks)):
302 if clocks == allowed_tuplet_clocks[i]:
303 return allowed_tuplets[i]
305 dur = 0; num = 1; den = 1;
306 g = gcd (clocks, clocks_per_1)
308 (dur, num) = (clocks_per_1 / g, clocks / g)
309 if not dur in self.allowed_durs:
310 dur = 4; num = clocks; den = clocks_per_4
311 return (dur, num, den)
317 elif self.num == 3 and self.dur != 1:
318 s = '%d.' % (self.dur / 2)
320 s = '%d*%d' % (self.dur, self.num)
322 s = '%d*%d/%d' % (self.dur, self.num, self.den)
324 global reference_note
325 reference_note.duration = self
329 def compare (self, other):
330 return self.clocks - other.clocks
339 names = (0, 0, 1, 1, 2, 3, 3, 4, 4, 5, 5, 6)
340 alterations = (0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0)
341 alteration_names = ('eses', 'es', '', 'is' , 'isis')
343 def __init__ (self, clocks, pitch, velocity):
345 self.velocity = velocity
348 self.duration = Duration (clocks)
349 (self.octave, self.notename, self.alteration) = self.o_n_a ()
353 # minor scale: la-la (= + 5) '''
355 n = self.names[(self.pitch) % 12]
356 a = self.alterations[(self.pitch) % 12]
359 a = - self.alterations[(self.pitch) % 12]
362 # By tradition, all scales now consist of a sequence
363 # of 7 notes each with a distinct name, from amongst
364 # a b c d e f g. But, minor scales have a wide
365 # second interval at the top - the 'leading note' is
366 # sharped. (Why? it just works that way! Anything
367 # else doesn't sound as good and isn't as flexible at
368 # saying things. In medieval times, scales only had 6
369 # notes to avoid this problem - the hexachords.)
371 # So, the d minor scale is d e f g a b-flat c-sharp d
372 # - using d-flat for the leading note would skip the
373 # name c and duplicate the name d. Why isn't c-sharp
374 # put in the key signature? Tradition. (It's also
375 # supposedly based on the Pythagorean theory of the
376 # cycle of fifths, but that really only applies to
377 # major scales...) Anyway, g minor is g a b-flat c d
378 # e-flat f-sharp g, and all the other flat minor keys
379 # end up with a natural leading note. And there you
382 # John Sankey <bf250@freenet.carleton.ca>
384 # Let's also do a-minor: a b c d e f gis a
388 o = self.pitch / 12 - 4
392 if key.sharps == 0 and key.flats == 0 \
393 and n == 5 and a == -1:
396 elif key.flats == 1 and n == 1 and a == -1:
399 elif key.flats == 2 and n == 4 and a == -1:
402 elif key.sharps == 5 and n == 4 and a == 0:
405 elif key.sharps == 6 and n == 1 and a == 0:
408 elif key.sharps == 7 and n == 5 and a == 0:
412 if key.flats >= 6 and n == 6 and a == 0:
413 n = 0; a = -1; o = o + 1
415 if key.flats >= 7 and n == 2 and a == 0:
419 if key.sharps >= 3 and n == 3 and a == 0:
422 if key.sharps >= 4 and n == 0 and a == 0:
423 n = 6; a = 1; o = o - 1
427 def dump (self, dump_dur = 1):
428 global reference_note
429 s = chr ((self.notename + 2) % 7 + ord ('a'))
430 s = s + self.alteration_names[self.alteration + 2]
434 delta = self.pitch - reference_note.pitch
435 commas = sign (delta) * (abs (delta) / 12)
437 * (self.notename - reference_note.notename) + 7) \
439 or ((self.notename == reference_note.notename) \
440 and (abs (delta) > 4) and (abs (delta) < 12)):
441 commas = commas + sign (delta)
446 s = s + "," * -commas
448 ## FIXME: compile fix --jcn
449 if dump_dur and (explicit_durations_p \
450 or Duration.compare (self.duration,
451 reference_note.duration)):
452 s = s + self.duration.dump ()
454 reference_note = self
461 def __init__ (self, num, den):
466 def bar_clocks (self):
467 return clocks_per_1 * self.num / self.den
472 return '\n ' + '\\time %d/%d ' % (self.num, self.den) + '\n '
475 def __init__ (self, seconds_per_1):
477 self.seconds_per_1 = seconds_per_1
480 return '\n ' + '\\tempo 4 = %d ' % (4 * 60 / self.seconds_per_1) + '\n '
483 clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
484 def __init__ (self, type):
488 return '\n \\clef %s\n ' % self.clefs[self.type]
491 key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
492 key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
494 def __init__ (self, sharps, flats, minor):
505 if self.sharps and self.flats:
506 s = '\\keysignature %s ' % 'TODO'
510 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
512 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
515 name = chr ((k + 2) % 7 + ord ('a'))
517 name = chr ((k + 2) % 7 + ord ('a'))
519 # fis cis gis dis ais eis bis
520 sharps = (2, 4, 6, 1, 3, 5, 7)
521 # bes es as des ges ces fes
522 flats = (6, 4, 2, 7, 5, 3, 1)
525 if flats[k] <= self.flats:
528 if sharps[k] <= self.sharps:
532 name = name + Note.alteration_names[a + 2]
540 return '\n\n ' + s + '\n '
548 'SEQUENCE_TRACK_NAME',
554 def __init__ (self, type, text):
560 # urg, we should be sure that we're in a lyrics staff
561 if self.type == midi.LYRIC:
562 s = '"%s"' % self.text
563 d = Duration (self.clocks)
564 if explicit_durations_p \
565 or Duration.compare (d,
566 reference_note.duration):
567 s = s + Duration (self.clocks).dump ()
570 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
574 def split_track (track):
581 if data[0] > 0x7f and data[0] < 0xf0:
583 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
593 for v in chs.values ():
594 events = events_on_channel (v)
595 thread = unthread_notes (events)
597 threads.append (thread)
601 def quantise_clocks (clocks, quant):
602 q = int (clocks / quant) * quant
604 for tquant in allowed_tuplet_clocks:
605 if int (clocks / tquant) * tquant == clocks:
607 if 2 * (clocks - q) > quant:
611 def end_note (pitches, notes, t, e):
613 (lt, vel) = pitches[e]
623 if duration_quant_clocks:
624 d = quantise_clocks (d, duration_quant_clocks)
626 d = duration_quant_clocks
629 (lt, Note (d, e, vel)))
634 def events_on_channel (channel):
644 if start_quant_clocks:
645 t = quantise_clocks (t, start_quant_clocks)
648 if e[1][0] == midi.NOTE_OFF \
649 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0):
650 end_note (pitches, notes, t, e[1][1])
652 elif e[1][0] == midi.NOTE_ON:
653 if not pitches.has_key (e[1][1]):
654 pitches[e[1][1]] = (t, e[1][2])
656 # all include ALL_NOTES_OFF
657 elif e[1][0] >= midi.ALL_SOUND_OFF \
658 and e[1][0] <= midi.POLY_MODE_ON:
659 for i in pitches.keys ():
660 end_note (pitches, notes, t, i)
662 elif e[1][0] == midi.META_EVENT:
663 if e[1][1] == midi.END_OF_TRACK:
664 for i in pitches.keys ():
665 end_note (pitches, notes, t, i)
668 elif e[1][1] == midi.SET_TEMPO:
669 (u0, u1, u2) = map (ord, e[1][2])
670 us_per_4 = u2 + 256 * (u1 + 256 * u0)
671 seconds_per_1 = us_per_4 * 4 / 1e6
672 events.append ((t, Tempo (seconds_per_1)))
673 elif e[1][1] == midi.TIME_SIGNATURE:
674 (num, dur, clocks4, count32) = map (ord, e[1][2])
676 events.append ((t, Time (num, den)))
677 elif e[1][1] == midi.KEY_SIGNATURE:
678 (alterations, minor) = map (ord, e[1][2])
681 if alterations < 127:
684 flats = 256 - alterations
686 k = Key (sharps, flats, minor)
687 events.append ((t, k))
689 # ugh, must set key while parsing
690 # because Note init uses key
691 # Better do Note.calc () at dump time?
695 elif e[1][1] == midi.LYRIC \
696 or (text_lyrics_p and e[1][1] == midi.TEXT_EVENT):
698 last_lyric.clocks = t - last_time
699 events.append ((last_time, last_lyric))
701 last_lyric = Text (midi.LYRIC, e[1][2])
703 elif e[1][1] >= midi.SEQUENCE_NUMBER \
704 and e[1][1] <= midi.CUE_POINT:
705 events.append ((t, Text (e[1][1], e[1][2])))
708 sys.stderr.write ("SKIP: %s\n" % `e`)
712 sys.stderr.write ("SKIP: %s\n" % `e`)
716 # last_lyric.clocks = t - last_time
718 last_lyric.clocks = clocks_per_4
719 events.append ((last_time, last_lyric))
724 if i < len (events) and notes[0][0] >= events[i][0]:
727 events.insert (i, notes[0])
731 def unthread_notes (channel):
740 if e[1].__class__ == Note \
741 and ((t == start_busy_t \
742 and e[1].clocks + t == end_busy_t) \
746 end_busy_t = t + e[1].clocks
747 elif e[1].__class__ == Time \
748 or e[1].__class__ == Key \
749 or e[1].__class__ == Text \
750 or e[1].__class__ == Tempo:
754 threads.append (thread)
769 def dump_skip (skip, clocks):
770 return skip + Duration (clocks).dump () + ' '
779 if i.__class__ == Note:
784 s = s + dump (notes[0])
785 elif len (notes) > 1:
786 global reference_note
788 s = s + notes[0].dump (dump_dur = 0)
791 s = s + i.dump (dump_dur = 0 )
794 s = s + notes[0].duration.dump() + ' '
798 def dump_bar_line (last_bar_t, t, bar_count):
800 bar_t = time.bar_clocks ()
801 if t - last_bar_t >= bar_t:
802 bar_count = bar_count + (t - last_bar_t) / bar_t
804 if t - last_bar_t == bar_t:
805 s = '|\n %% %d\n ' % bar_count
808 # urg, this will barf at meter changes
809 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
811 return (s, last_bar_t, bar_count)
814 def dump_channel (thread, skip):
815 global key, reference_note, time
819 # urg LilyPond doesn't start at c4, but
820 # remembers from previous tracks!
821 # reference_note = Note (clocks_per_4, 4*12, 0)
822 reference_note = Note (0, 4*12, 0)
828 if last_e and last_e[0] == e[0]:
832 chs.append ((last_e[0], ch))
839 chs.append ((last_e[0], ch))
849 i = string.rfind (lines[-1], '\n') + 1
850 if len (lines[-1][i:]) > LINE_BELL:
854 lines[-1] = lines[-1] + dump_skip (skip, t-last_t)
856 errorport.write ('BUG: time skew')
858 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
860 lines[-1] = lines[-1] + s
862 lines[-1] = lines[-1] + dump_chord (ch[1])
866 if i.clocks > clocks:
871 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
873 lines[-1] = lines[-1] + s
875 return string.join (lines, '\n ') + '\n'
878 return 'track%c' % (i + ord ('A'))
880 def channel_name (i):
881 return 'channel%c' % (i + ord ('A'))
883 def dump_track (channels, n):
885 track = track_name (n)
886 clef = guess_clef (channels)
888 for i in range (len (channels)):
889 channel = channel_name (i)
890 item = thread_first_item (channels[i])
892 if item and item.__class__ == Note:
894 s = s + '%s = \\notes' % (track + channel)
896 s = s + '\\relative c '
897 elif item and item.__class__ == Text:
899 s = s + '%s = \\lyricmode ' % (track + channel)
902 # must be in \notes mode for parsing \skip
903 s = s + '%s = \\notes ' % (track + channel)
905 s = s + ' ' + dump_channel (channels[i][0], skip)
908 s = s + '%s = <<\n' % track
911 s = s + clef.dump () + '\n'
913 for i in range (len (channels)):
914 channel = channel_name (i)
915 item = thread_first_item (channels[i])
916 if item and item.__class__ == Text:
917 s = s + ' \\context Lyrics = %s \\%s\n' % (channel,
920 s = s + ' \\context Voice = %s \\%s\n' % (channel,
925 def thread_first_item (thread):
928 if event[1].__class__ == Note \
929 or (event[1].__class__ == Text \
930 and event[1].type == midi.LYRIC):
934 def track_first_item (track):
936 return thread_first_item (thread)
938 def guess_clef (track):
944 if event[1].__class__ == Note:
946 p = p + event[1].pitch
947 if i and p / i <= 3*12:
949 elif i and p / i <= 5*12:
951 elif i and p / i >= 7*12:
957 def convert_midi (f, o):
958 global clocks_per_1, clocks_per_4, key
960 str = open (f).read ()
961 midi_dump = midi.parse (str)
963 clocks_per_1 = midi_dump[0][1]
964 clocks_per_4 = clocks_per_1 / 4
966 global start_quant, start_quant_clocks
968 start_quant_clocks = clocks_per_1 / start_quant
970 global duration_quant, duration_quant_clocks
972 duration_quant_clocks = clocks_per_1 / duration_quant
974 global allowed_tuplet_clocks
975 allowed_tuplet_clocks = []
976 for (dur, num, den) in allowed_tuplets:
977 allowed_tuplet_clocks.append (clocks_per_1 * num / (dur * den))
980 for t in midi_dump[1]:
982 tracks.append (split_track (t))
984 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, f)
988 for i in range (len (tracks)):
989 s = s + dump_track (tracks[i], i)
991 s = s + '\n\\score {\n <<\n'
992 for i in range (len (tracks)):
993 track = track_name (i)
994 item = track_first_item (tracks[i])
995 if item and item.__class__ == Note:
996 s = s + ' \\context Staff=%s \\%s\n' % (track, track)
997 elif item and item.__class__ == Text:
998 s = s + ' \\context Lyrics=%s \\%s\n' % (track, track)
1001 progress (_ ("%s output to `%s'...") % ('LY', o))
1012 (sh, long) = getopt_args (option_definitions)
1014 (options, files) = getopt.getopt(sys.argv[1:], sh, long)
1015 except getopt.error, s:
1016 errorport.write ('\n')
1017 errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
1018 errorport.write ('\n')
1019 errorport.write ('\n')
1029 elif o == '--help' or o == '-h':
1031 errorport.write ('\n')
1032 errorport.write (_ ("Example:"))
1033 errorport.write (r'''
1034 midi2ly --key=-2:1 --duration-quant=32 \
1035 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
1038 elif o == '--output' or o == '-o':
1040 elif o == '--verbose' or o == '-V':
1042 elif o == '--version' or o == '-v':
1045 elif o == '--warranty' or o == '-w':
1046 status = system ('lilypond -w', ignore_error = 1)
1052 elif o == '--absolute-pitches' or o == '-a':
1054 elif o == '--duration-quant' or o == '-d':
1055 duration_quant = string.atoi (a)
1056 elif o == '--explicit-durations' or o == '-e':
1057 explicit_durations_p = 1
1058 elif o == '--key' or o == '-k':
1059 (alterations, minor) = map (string.atoi, string.split (a + ':0', ':'))[0:2]
1062 if alterations >= 0:
1063 sharps = alterations
1065 flats = - alterations
1066 key = Key (sharps, flats, minor)
1067 elif o == '--start-quant' or o == '-s':
1068 start_quant = string.atoi (a)
1069 elif o == '--allow-tuplet' or o == '-t':
1070 a = string.replace (a, '/', '*')
1071 tuplet = map (string.atoi, string.split (a, '*'))
1072 allowed_tuplets.append (tuplet)
1073 # lots of midi files use plain text for lyric events
1074 elif o == '--text-lyrics' or o == '-x':
1078 if not files or files[0] == '-':
1080 # FIXME: read from stdin when files[0] = '-'
1082 errorport.write (program_name + ":" + _ ("error: ") + _ ("no files specified on command line.") + '\n')
1089 g = strip_extension (g, '.midi')
1090 g = strip_extension (g, '.mid')
1091 g = strip_extension (g, '.MID')
1092 (outdir, outbase) = ('','')
1096 outbase = os.path.basename (g)
1097 o = os.path.join (outdir, outbase + '-midi.ly')
1098 elif output_name[-1] == os.sep:
1099 outdir = output_name
1100 outbase = os.path.basename (g)
1101 os.path.join (outdir, outbase + '-gen.ly')
1104 (outdir, outbase) = os.path.split (o)
1106 if outdir != '.' and outdir != '':
1108 os.mkdir (outdir, 0777)