3 # msdi2ly.py -- LilyPond midi import script
5 # source file of the GNU LilyPond music typesetter
7 # (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
8 # Jan Nieuwenhuizen <janneke@gnu.org>
13 * test on weird and unquantised midi input (lily-devel)
14 * update doc and manpage
16 * simply insert clef changes whenever too many ledger lines
17 [to avoid tex capacity exceeded]
18 * do not ever quant skips
19 * better lyrics handling
20 * [see if it is feasible to] move ly-classes to library for use in
21 other converters, while leaving midi specific stuff here
29 ################################################################
30 # Users of python modules should include this snippet.
32 libdir = '@local_lilypond_libdir@'
33 if not os.path.isdir (libdir):
34 libdir = '@lilypond_libdir@'
37 datadir = '@local_lilypond_datadir@'
38 if os.environ.has_key ('LILYPONDPREFIX'):
39 datadir = os.environ['LILYPONDPREFIX']
40 while datadir[-1] == os.sep:
42 libdir = datadir.replace ('/share/', '/lib/')
44 if os.path.exists (os.path.join (datadir, 'lib/lilypond/@TOPLEVEL_VERSION@/')):
45 libdir = os.path.join (libdir, 'lib/lilypond/@TOPLEVEL_VERSION@/')
47 if os.path.exists (os.path.join (datadir, 'lib/lilypond/current/')):
48 libdir = os.path.join (libdir, 'lib/lilypond/current/')
50 sys.path.insert (0, os.path.join (libdir, 'python'))
52 # dynamic relocation, for GUB binaries.
53 bindir = os.path.split (sys.argv[0])[0]
55 for prefix_component in ['share', 'lib']:
56 datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % prefix_component)
57 sys.path.insert (0, datadir)
62 ################################################################
63 ################ CONSTANTS
68 scale_steps = [0,2,4,5,7,9,11]
77 start_quant_clocks = 0
79 duration_quant_clocks = 0
80 allowed_tuplet_clocks = []
83 ################################################################
85 localedir = '@localedir@'
88 gettext.bindtextdomain ('lilypond', localedir)
89 gettext.textdomain ('lilypond')
95 program_name = sys.argv[0]
96 program_version = '@TOPLEVEL_VERSION@'
98 errorport = sys.stderr
101 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
105 sys.stdout.write ('''
114 _('Distributed under terms of the GNU General Public License.'),
115 _('It comes with NO WARRANTY.')))
119 errorport.write (s + '\n')
122 progress (_ ("warning: ") + s)
125 progress (_ ("error: ") + s)
126 raise _ ("Exiting ... ")
128 def system (cmd, ignore_error = 0):
129 return ly.system (cmd, ignore_error=ignore_error)
131 def strip_extension (f, ext):
132 (p, e) = os.path.splitext (f)
141 allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
142 def __init__ (self, clocks):
145 self.clocks = duration_quant_clocks
146 (self.dur, self.num, self.den) = self.dur_num_den (clocks)
148 def dur_num_den (self, clocks):
149 for i in range (len (allowed_tuplet_clocks)):
150 if clocks == allowed_tuplet_clocks[i]:
151 return global_options.allowed_tuplets[i]
153 dur = 0; num = 1; den = 1;
154 g = gcd (clocks, clocks_per_1)
156 (dur, num) = (clocks_per_1 / g, clocks / g)
157 if not dur in self.allowed_durs:
158 dur = 4; num = clocks; den = clocks_per_4
159 return (dur, num, den)
165 elif self.num == 3 and self.dur != 1:
166 s = '%d.' % (self.dur / 2)
168 s = '%d*%d' % (self.dur, self.num)
170 s = '%d*%d/%d' % (self.dur, self.num, self.den)
172 global reference_note
173 reference_note.duration = self
177 def compare (self, other):
178 return self.clocks - other.clocks
187 names = (0, 0, 1, 1, 2, 3, 3, 4, 4, 5, 5, 6)
188 alterations = (0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0)
189 alteration_names = ('eses', 'es', '', 'is' , 'isis')
190 def __init__ (self, clocks, pitch, velocity):
192 self.velocity = velocity
195 self.duration = Duration (clocks)
196 (self.octave, self.notename, self.alteration) = self.o_n_a ()
200 # minor scale: la-la (= + 5) '''
202 n = self.names[(self.pitch) % 12]
203 a = self.alterations[(self.pitch) % 12]
205 if a and global_options.key.flats:
206 a = - self.alterations[(self.pitch) % 12]
209 # By tradition, all scales now consist of a sequence
210 # of 7 notes each with a distinct name, from amongst
211 # a b c d e f g. But, minor scales have a wide
212 # second interval at the top - the 'leading note' is
213 # sharped. (Why? it just works that way! Anything
214 # else doesn't sound as good and isn't as flexible at
215 # saying things. In medieval times, scales only had 6
216 # notes to avoid this problem - the hexachords.)
218 # So, the d minor scale is d e f g a b-flat c-sharp d
219 # - using d-flat for the leading note would skip the
220 # name c and duplicate the name d. Why isn't c-sharp
221 # put in the key signature? Tradition. (It's also
222 # supposedly based on the Pythagorean theory of the
223 # cycle of fifths, but that really only applies to
224 # major scales...) Anyway, g minor is g a b-flat c d
225 # e-flat f-sharp g, and all the other flat minor keys
226 # end up with a natural leading note. And there you
229 # John Sankey <bf250@freenet.carleton.ca>
231 # Let's also do a-minor: a b c d e f gis a
235 o = self.pitch / 12 - 4
237 key = global_options.key
240 if (key.sharps == 0 and key.flats == 0
241 and n == 5 and a == -1):
244 elif key.flats == 1 and n == 1 and a == -1:
247 elif key.flats == 2 and n == 4 and a == -1:
250 elif key.sharps == 5 and n == 4 and a == 0:
253 elif key.sharps == 6 and n == 1 and a == 0:
256 elif key.sharps == 7 and n == 5 and a == 0:
260 if key.flats >= 6 and n == 6 and a == 0:
261 n = 0; a = -1; o = o + 1
263 if key.flats >= 7 and n == 2 and a == 0:
267 if key.sharps >= 3 and n == 3 and a == 0:
270 if key.sharps >= 4 and n == 0 and a == 0:
271 n = 6; a = 1; o = o - 1
276 s = chr ((self.notename + 2) % 7 + ord ('a'))
277 return 'Note(%s %s)' % (s, self.duration.dump())
279 def dump (self, dump_dur = 1):
280 global reference_note
281 s = chr ((self.notename + 2) % 7 + ord ('a'))
282 s = s + self.alteration_names[self.alteration + 2]
283 if global_options.absolute_pitches:
286 delta = self.pitch - reference_note.pitch
287 commas = sign (delta) * (abs (delta) / 12)
289 * (self.notename - reference_note.notename) + 7) \
291 or ((self.notename == reference_note.notename) \
292 and (abs (delta) > 4) and (abs (delta) < 12)):
293 commas = commas + sign (delta)
298 s = s + "," * -commas
300 ## FIXME: compile fix --jcn
301 if dump_dur and (global_options.explicit_durations \
302 or self.duration.compare (reference_note.duration)):
303 s = s + self.duration.dump ()
305 reference_note = self
312 def __init__ (self, num, den):
317 def bar_clocks (self):
318 return clocks_per_1 * self.num / self.den
321 return 'Time(%d/%d)' % (self.num, self.den)
326 return '\n ' + '\\time %d/%d ' % (self.num, self.den) + '\n '
329 def __init__ (self, seconds_per_1):
331 self.seconds_per_1 = seconds_per_1
334 return 'Tempo(%d)' % self.bpm ()
337 return 4 * 60 / self.seconds_per_1
340 return '\n ' + '\\tempo 4 = %d ' % (self.bpm()) + '\n '
343 clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
344 def __init__ (self, type):
348 return 'Clef(%s)' % self.clefs[self.type]
351 return '\n \\clef %s\n ' % self.clefs[self.type]
354 key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
355 key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
357 def __init__ (self, sharps, flats, minor):
364 global_options.key = self
367 if self.sharps and self.flats:
371 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
373 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
376 name = chr ((k + 2) % 7 + ord ('a'))
378 name = chr ((k + 2) % 7 + ord ('a'))
380 # fis cis gis dis ais eis bis
381 sharps = (2, 4, 6, 1, 3, 5, 7)
382 # bes es as des ges ces fes
383 flats = (6, 4, 2, 7, 5, 3, 1)
386 if flats[k] <= self.flats:
389 if sharps[k] <= self.sharps:
393 name = name + Note.alteration_names[a + 2]
401 return '\n\n ' + s + '\n '
409 'SEQUENCE_TRACK_NAME',
415 def __init__ (self, type, text):
421 # urg, we should be sure that we're in a lyrics staff
422 if self.type == midi.LYRIC:
423 s = '"%s"' % self.text
424 d = Duration (self.clocks)
425 if global_options.explicit_durations \
426 or d.compare (reference_note.duration):
427 s = s + Duration (self.clocks).dump ()
430 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
434 return 'Text(%d=%s)' % (self.type, self.text)
438 def split_track (track):
445 if data[0] > 0x7f and data[0] < 0xf0:
447 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
457 for v in chs.values ():
458 events = events_on_channel (v)
459 thread = unthread_notes (events)
461 threads.append (thread)
465 def quantise_clocks (clocks, quant):
466 q = int (clocks / quant) * quant
468 for tquant in allowed_tuplet_clocks:
469 if int (clocks / tquant) * tquant == clocks:
471 if 2 * (clocks - q) > quant:
475 def end_note (pitches, notes, t, e):
477 (lt, vel) = pitches[e]
487 if duration_quant_clocks:
488 d = quantise_clocks (d, duration_quant_clocks)
490 d = duration_quant_clocks
493 (lt, Note (d, e, vel)))
498 def events_on_channel (channel):
508 if start_quant_clocks:
509 t = quantise_clocks (t, start_quant_clocks)
512 if e[1][0] == midi.NOTE_OFF \
513 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0):
514 end_note (pitches, notes, t, e[1][1])
516 elif e[1][0] == midi.NOTE_ON:
517 if not pitches.has_key (e[1][1]):
518 pitches[e[1][1]] = (t, e[1][2])
520 # all include ALL_NOTES_OFF
521 elif e[1][0] >= midi.ALL_SOUND_OFF \
522 and e[1][0] <= midi.POLY_MODE_ON:
523 for i in pitches.keys ():
524 end_note (pitches, notes, t, i)
526 elif e[1][0] == midi.META_EVENT:
527 if e[1][1] == midi.END_OF_TRACK:
528 for i in pitches.keys ():
529 end_note (pitches, notes, t, i)
532 elif e[1][1] == midi.SET_TEMPO:
533 (u0, u1, u2) = map (ord, e[1][2])
534 us_per_4 = u2 + 256 * (u1 + 256 * u0)
535 seconds_per_1 = us_per_4 * 4 / 1e6
536 events.append ((t, Tempo (seconds_per_1)))
537 elif e[1][1] == midi.TIME_SIGNATURE:
538 (num, dur, clocks4, count32) = map (ord, e[1][2])
540 events.append ((t, Time (num, den)))
541 elif e[1][1] == midi.KEY_SIGNATURE:
542 (alterations, minor) = map (ord, e[1][2])
545 if alterations < 127:
548 flats = 256 - alterations
550 k = Key (sharps, flats, minor)
551 events.append ((t, k))
553 # ugh, must set key while parsing
554 # because Note init uses key
555 # Better do Note.calc () at dump time?
556 global_options.key = k
558 elif e[1][1] == midi.LYRIC \
559 or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT):
561 last_lyric.clocks = t - last_time
562 events.append ((last_time, last_lyric))
564 last_lyric = Text (midi.LYRIC, e[1][2])
566 elif e[1][1] >= midi.SEQUENCE_NUMBER \
567 and e[1][1] <= midi.CUE_POINT:
568 events.append ((t, Text (e[1][1], e[1][2])))
570 if global_options.verbose:
571 sys.stderr.write ("SKIP: %s\n" % `e`)
574 if global_options.verbose:
575 sys.stderr.write ("SKIP: %s\n" % `e`)
579 # last_lyric.clocks = t - last_time
581 last_lyric.clocks = clocks_per_4
582 events.append ((last_time, last_lyric))
587 if i < len (events) and notes[0][0] >= events[i][0]:
590 events.insert (i, notes[0])
594 def unthread_notes (channel):
603 if e[1].__class__ == Note \
604 and ((t == start_busy_t \
605 and e[1].clocks + t == end_busy_t) \
609 end_busy_t = t + e[1].clocks
610 elif e[1].__class__ == Time \
611 or e[1].__class__ == Key \
612 or e[1].__class__ == Text \
613 or e[1].__class__ == Tempo:
617 threads.append (thread)
632 def dump_skip (skip, clocks):
633 return skip + Duration (clocks).dump () + ' '
642 if i.__class__ == Note:
647 s = s + dump (notes[0])
648 elif len (notes) > 1:
649 global reference_note
651 s = s + notes[0].dump (dump_dur = 0)
654 s = s + i.dump (dump_dur = 0 )
657 s = s + notes[0].duration.dump() + ' '
661 def dump_bar_line (last_bar_t, t, bar_count):
663 bar_t = time.bar_clocks ()
664 if t - last_bar_t >= bar_t:
665 bar_count = bar_count + (t - last_bar_t) / bar_t
667 if t - last_bar_t == bar_t:
668 s = '|\n %% %d\n ' % bar_count
671 # urg, this will barf at meter changes
672 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
674 return (s, last_bar_t, bar_count)
677 def dump_channel (thread, skip):
678 global reference_note, time
680 global_options.key = Key (0, 0, 0)
682 # urg LilyPond doesn't start at c4, but
683 # remembers from previous tracks!
684 # reference_note = Note (clocks_per_4, 4*12, 0)
685 reference_note = Note (0, 4*12, 0)
691 if last_e and last_e[0] == e[0]:
695 chs.append ((last_e[0], ch))
702 chs.append ((last_e[0], ch))
712 i = string.rfind (lines[-1], '\n') + 1
713 if len (lines[-1][i:]) > LINE_BELL:
717 lines[-1] = lines[-1] + dump_skip (skip, t-last_t)
719 errorport.write ('BUG: time skew')
721 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
723 lines[-1] = lines[-1] + s
725 lines[-1] = lines[-1] + dump_chord (ch[1])
729 if i.clocks > clocks:
734 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
736 lines[-1] = lines[-1] + s
738 return string.join (lines, '\n ') + '\n'
741 return 'track%c' % (i + ord ('A'))
743 def channel_name (i):
744 return 'channel%c' % (i + ord ('A'))
746 def dump_track (channels, n):
748 track = track_name (n)
749 clef = guess_clef (channels)
751 for i in range (len (channels)):
752 channel = channel_name (i)
753 item = thread_first_item (channels[i])
755 if item and item.__class__ == Note:
757 s = s + '%s = ' % (track + channel)
758 if not global_options.absolute_pitches:
759 s = s + '\\relative c '
760 elif item and item.__class__ == Text:
762 s = s + '%s = \\lyricmode ' % (track + channel)
765 s = s + '%s = ' % (track + channel)
767 s = s + ' ' + dump_channel (channels[i][0], skip)
770 s = s + '%s = <<\n' % track
773 s = s + clef.dump () + '\n'
775 for i in range (len (channels)):
776 channel = channel_name (i)
777 item = thread_first_item (channels[i])
778 if item and item.__class__ == Text:
779 s = s + ' \\context Lyrics = %s \\%s\n' % (channel,
782 s = s + ' \\context Voice = %s \\%s\n' % (channel,
787 def thread_first_item (thread):
790 if (event[1].__class__ == Note
791 or (event[1].__class__ == Text
792 and event[1].type == midi.LYRIC)):
797 def track_first_item (track):
799 first = thread_first_item (thread)
804 def guess_clef (track):
810 if event[1].__class__ == Note:
812 p = p + event[1].pitch
813 if i and p / i <= 3*12:
815 elif i and p / i <= 5*12:
817 elif i and p / i >= 7*12:
823 def convert_midi (in_file, out_file):
824 global clocks_per_1, clocks_per_4, key
825 global start_quant_clocks
826 global duration_quant_clocks
827 global allowed_tuplet_clocks
829 str = open (in_file).read ()
830 midi_dump = midi.parse (str)
832 clocks_per_1 = midi_dump[0][1]
833 clocks_per_4 = clocks_per_1 / 4
835 if global_options.start_quant:
836 start_quant_clocks = clocks_per_1 / global_options.start_quant
838 if global_options.duration_quant:
839 duration_quant_clocks = clocks_per_1 / global_options.duration_quant
841 allowed_tuplet_clocks = []
842 for (dur, num, den) in global_options.allowed_tuplets:
843 allowed_tuplet_clocks.append (clocks_per_1 / den)
846 for t in midi_dump[1]:
847 global_options.key = Key (0, 0, 0)
848 tracks.append (split_track (t))
850 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, in_file)
854 s = tag + '\n\\version "2.7.18"\n\n'
855 for i in range (len (tracks)):
856 s = s + dump_track (tracks[i], i)
858 s = s + '\n\\score {\n <<\n'
862 track = track_name (i)
863 item = track_first_item (t)
865 if item and item.__class__ == Note:
866 s = s + ' \\context Staff=%s \\%s\n' % (track, track)
867 elif item and item.__class__ == Text:
868 s = s + ' \\context Lyrics=%s \\%s\n' % (track, track)
873 progress (_ ("%s output to `%s'...") % ('LY', out_file))
878 handle = open (out_file, 'w')
884 def get_option_parser ():
885 p = ly.get_option_parser (usage='midi2ly [OPTIONS] FILE',
886 version="midi2ly (LilyPond) @TOPLEVEL_VERSION@",
887 description=_('''Convert MIDI to LilyPond source.'''))
889 p.add_option ('-a', '--absolute-pitches',
891 help=_ ("print absolute pitches"))
892 p.add_option ('-d', '--duration-quant',
894 help=_("quantise note durations on DUR"))
895 p.add_option ('-e', '--explicit-durations',
897 help=_ ("print explicit durations"))
898 p.add_option('-k', '--key', help=_ ("set key: ALT=+sharps|-flats; MINOR=1"),
899 metavar=_ ("ALT[:MINOR]"),
901 p.add_option ('-o', '--output', help=_("write output to FILE"),
904 p.add_option ('-s', '--start-quant',help= _ ("quantise note starts on DUR"),
906 p.add_option ('-t', '--allow-tuplet',
907 metavar=_ ("DUR*NUM/DEN"),
909 dest="allowed_tuplets",
910 help=_ ("allow tuplet durations DUR*NUM/DEN"),
912 p.add_option ('-V', '--verbose', help=_("be verbose"),
915 p.add_option ('-w', '--warranty', help=_("show warranty"),
918 p.add_option ('-x', '--text-lyrics', help=_("treat every text as a lyric"),
921 p.add_option_group (_ ("example"),
923 midi2ly --key=-2:1 --duration-quant=32 \
924 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
927 p.add_option_group ('bugs',
928 description='''Report bugs via http://post.gmane.org/post.php'''
929 '''?group=gmane.comp.gnu.lilypond.bugs\n''')
936 opt_parser = get_option_parser()
937 (options, args) = opt_parser.parse_args ()
939 if not args or args[0] == '-':
940 opt_parser.print_help ()
941 sys.stderr.write ('\n%s: %s %s\n' % (program_name, _ ("error: "),
942 _ ("no files specified on command line.")))
945 if options.duration_quant:
946 options.duration_quant = int (options.duration_quant)
952 (alterations, minor) = map (int, string.split (options.key + ':0', ':'))[0:2]
958 flats = - alterations
960 options.key = Key (sharps, flats, minor)
963 if options.start_quant:
964 options.start_quant = int (options.start_quant)
966 options.allowed_tuplets = [map (int, a.replace ('/','*').split ('*'))
967 for a in options.allowed_tuplets]
969 global global_options
970 global_options = options
979 g = strip_extension (g, '.midi')
980 g = strip_extension (g, '.mid')
981 g = strip_extension (g, '.MID')
982 (outdir, outbase) = ('','')
986 outbase = os.path.basename (g)
987 o = os.path.join (outdir, outbase + '-midi.ly')
988 elif output_name[-1] == os.sep:
990 outbase = os.path.basename (g)
991 os.path.join (outdir, outbase + '-gen.ly')
994 (outdir, outbase) = os.path.split (o)
996 if outdir != '.' and outdir != '':
998 os.mkdir (outdir, 0777)
1003 if __name__ == '__main__':