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
30 ################################################################
31 # Users of python modules should include this snippet.
33 libdir = '@local_lilypond_libdir@'
34 if not os.path.isdir (libdir):
35 libdir = '@lilypond_libdir@'
38 datadir = '@local_lilypond_datadir@'
39 if os.environ.has_key ('LILYPONDPREFIX'):
40 datadir = os.environ['LILYPONDPREFIX']
41 while datadir[-1] == os.sep:
43 libdir = datadir.replace ('/share/', '/lib/')
45 if os.path.exists (os.path.join (datadir, 'lib/lilypond/@TOPLEVEL_VERSION@/')):
46 libdir = os.path.join (libdir, 'lib/lilypond/@TOPLEVEL_VERSION@/')
48 if os.path.exists (os.path.join (datadir, 'lib/lilypond/current/')):
49 libdir = os.path.join (libdir, 'lib/lilypond/current/')
51 sys.path.insert (0, os.path.join (libdir, 'python'))
53 # dynamic relocation, for GUB binaries.
54 bindir = os.path.split (sys.argv[0])[0]
55 for p in ['share', 'lib']:
56 datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % p)
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 Duration.compare (self.duration,
303 reference_note.duration)):
304 s = s + self.duration.dump ()
306 reference_note = self
313 def __init__ (self, num, den):
318 def bar_clocks (self):
319 return clocks_per_1 * self.num / self.den
322 return 'Time(%d/%d)' % (self.num, self.den)
327 return '\n ' + '\\time %d/%d ' % (self.num, self.den) + '\n '
330 def __init__ (self, seconds_per_1):
332 self.seconds_per_1 = seconds_per_1
335 return 'Tempo(%d)' % self.bpm ()
338 return 4 * 60 / self.seconds_per_1
341 return '\n ' + '\\tempo 4 = %d ' % (self.bpm()) + '\n '
344 clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
345 def __init__ (self, type):
349 return 'Clef(%s)' % self.clefs[self.type]
352 return '\n \\clef %s\n ' % self.clefs[self.type]
355 key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
356 key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
358 def __init__ (self, sharps, flats, minor):
369 if self.sharps and self.flats:
373 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
375 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
378 name = chr ((k + 2) % 7 + ord ('a'))
380 name = chr ((k + 2) % 7 + ord ('a'))
382 # fis cis gis dis ais eis bis
383 sharps = (2, 4, 6, 1, 3, 5, 7)
384 # bes es as des ges ces fes
385 flats = (6, 4, 2, 7, 5, 3, 1)
388 if flats[k] <= self.flats:
391 if sharps[k] <= self.sharps:
395 name = name + Note.alteration_names[a + 2]
403 return '\n\n ' + s + '\n '
411 'SEQUENCE_TRACK_NAME',
417 def __init__ (self, type, text):
423 # urg, we should be sure that we're in a lyrics staff
424 if self.type == midi.LYRIC:
425 s = '"%s"' % self.text
426 d = Duration (self.clocks)
427 if global_options.explicit_durations \
428 or Duration.compare (d,
429 reference_note.duration):
430 s = s + Duration (self.clocks).dump ()
433 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
437 return 'Text(%d=%s)' % (self.type, self.text)
441 def split_track (track):
448 if data[0] > 0x7f and data[0] < 0xf0:
450 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
460 for v in chs.values ():
461 events = events_on_channel (v)
462 thread = unthread_notes (events)
464 threads.append (thread)
468 def quantise_clocks (clocks, quant):
469 q = int (clocks / quant) * quant
471 for tquant in allowed_tuplet_clocks:
472 if int (clocks / tquant) * tquant == clocks:
474 if 2 * (clocks - q) > quant:
478 def end_note (pitches, notes, t, e):
480 (lt, vel) = pitches[e]
490 if duration_quant_clocks:
491 d = quantise_clocks (d, duration_quant_clocks)
493 d = duration_quant_clocks
496 (lt, Note (d, e, vel)))
501 def events_on_channel (channel):
511 if start_quant_clocks:
512 t = quantise_clocks (t, start_quant_clocks)
515 if e[1][0] == midi.NOTE_OFF \
516 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0):
517 end_note (pitches, notes, t, e[1][1])
519 elif e[1][0] == midi.NOTE_ON:
520 if not pitches.has_key (e[1][1]):
521 pitches[e[1][1]] = (t, e[1][2])
523 # all include ALL_NOTES_OFF
524 elif e[1][0] >= midi.ALL_SOUND_OFF \
525 and e[1][0] <= midi.POLY_MODE_ON:
526 for i in pitches.keys ():
527 end_note (pitches, notes, t, i)
529 elif e[1][0] == midi.META_EVENT:
530 if e[1][1] == midi.END_OF_TRACK:
531 for i in pitches.keys ():
532 end_note (pitches, notes, t, i)
535 elif e[1][1] == midi.SET_TEMPO:
536 (u0, u1, u2) = map (ord, e[1][2])
537 us_per_4 = u2 + 256 * (u1 + 256 * u0)
538 seconds_per_1 = us_per_4 * 4 / 1e6
539 events.append ((t, Tempo (seconds_per_1)))
540 elif e[1][1] == midi.TIME_SIGNATURE:
541 (num, dur, clocks4, count32) = map (ord, e[1][2])
543 events.append ((t, Time (num, den)))
544 elif e[1][1] == midi.KEY_SIGNATURE:
545 (alterations, minor) = map (ord, e[1][2])
548 if alterations < 127:
551 flats = 256 - alterations
553 k = Key (sharps, flats, minor)
554 events.append ((t, k))
556 # ugh, must set key while parsing
557 # because Note init uses key
558 # Better do Note.calc () at dump time?
562 elif e[1][1] == midi.LYRIC \
563 or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT):
565 last_lyric.clocks = t - last_time
566 events.append ((last_time, last_lyric))
568 last_lyric = Text (midi.LYRIC, e[1][2])
570 elif e[1][1] >= midi.SEQUENCE_NUMBER \
571 and e[1][1] <= midi.CUE_POINT:
572 events.append ((t, Text (e[1][1], e[1][2])))
574 if global_options.verbose:
575 sys.stderr.write ("SKIP: %s\n" % `e`)
578 if global_options.verbose:
579 sys.stderr.write ("SKIP: %s\n" % `e`)
583 # last_lyric.clocks = t - last_time
585 last_lyric.clocks = clocks_per_4
586 events.append ((last_time, last_lyric))
591 if i < len (events) and notes[0][0] >= events[i][0]:
594 events.insert (i, notes[0])
598 def unthread_notes (channel):
607 if e[1].__class__ == Note \
608 and ((t == start_busy_t \
609 and e[1].clocks + t == end_busy_t) \
613 end_busy_t = t + e[1].clocks
614 elif e[1].__class__ == Time \
615 or e[1].__class__ == Key \
616 or e[1].__class__ == Text \
617 or e[1].__class__ == Tempo:
621 threads.append (thread)
636 def dump_skip (skip, clocks):
637 return skip + Duration (clocks).dump () + ' '
646 if i.__class__ == Note:
651 s = s + dump (notes[0])
652 elif len (notes) > 1:
653 global reference_note
655 s = s + notes[0].dump (dump_dur = 0)
658 s = s + i.dump (dump_dur = 0 )
661 s = s + notes[0].duration.dump() + ' '
665 def dump_bar_line (last_bar_t, t, bar_count):
667 bar_t = time.bar_clocks ()
668 if t - last_bar_t >= bar_t:
669 bar_count = bar_count + (t - last_bar_t) / bar_t
671 if t - last_bar_t == bar_t:
672 s = '|\n %% %d\n ' % bar_count
675 # urg, this will barf at meter changes
676 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
678 return (s, last_bar_t, bar_count)
681 def dump_channel (thread, skip):
682 global key, reference_note, time
686 # urg LilyPond doesn't start at c4, but
687 # remembers from previous tracks!
688 # reference_note = Note (clocks_per_4, 4*12, 0)
689 reference_note = Note (0, 4*12, 0)
695 if last_e and last_e[0] == e[0]:
699 chs.append ((last_e[0], ch))
706 chs.append ((last_e[0], ch))
716 i = string.rfind (lines[-1], '\n') + 1
717 if len (lines[-1][i:]) > LINE_BELL:
721 lines[-1] = lines[-1] + dump_skip (skip, t-last_t)
723 errorport.write ('BUG: time skew')
725 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
727 lines[-1] = lines[-1] + s
729 lines[-1] = lines[-1] + dump_chord (ch[1])
733 if i.clocks > clocks:
738 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
740 lines[-1] = lines[-1] + s
742 return string.join (lines, '\n ') + '\n'
745 return 'track%c' % (i + ord ('A'))
747 def channel_name (i):
748 return 'channel%c' % (i + ord ('A'))
750 def dump_track (channels, n):
752 track = track_name (n)
753 clef = guess_clef (channels)
755 for i in range (len (channels)):
756 channel = channel_name (i)
757 item = thread_first_item (channels[i])
759 if item and item.__class__ == Note:
761 s = s + '%s = ' % (track + channel)
762 if not global_options.absolute_pitches:
763 s = s + '\\relative c '
764 elif item and item.__class__ == Text:
766 s = s + '%s = \\lyricmode ' % (track + channel)
769 s = s + '%s = ' % (track + channel)
771 s = s + ' ' + dump_channel (channels[i][0], skip)
774 s = s + '%s = <<\n' % track
777 s = s + clef.dump () + '\n'
779 for i in range (len (channels)):
780 channel = channel_name (i)
781 item = thread_first_item (channels[i])
782 if item and item.__class__ == Text:
783 s = s + ' \\context Lyrics = %s \\%s\n' % (channel,
786 s = s + ' \\context Voice = %s \\%s\n' % (channel,
791 def thread_first_item (thread):
794 if (event[1].__class__ == Note
795 or (event[1].__class__ == Text
796 and event[1].type == midi.LYRIC)):
801 def track_first_item (track):
803 first = thread_first_item (thread)
808 def guess_clef (track):
814 if event[1].__class__ == Note:
816 p = p + event[1].pitch
817 if i and p / i <= 3*12:
819 elif i and p / i <= 5*12:
821 elif i and p / i >= 7*12:
827 def convert_midi (in_file, out_file):
828 global clocks_per_1, clocks_per_4, key
829 global start_quant_clocks
830 global duration_quant_clocks
831 global allowed_tuplet_clocks
833 str = open (in_file).read ()
834 midi_dump = midi.parse (str)
836 clocks_per_1 = midi_dump[0][1]
837 clocks_per_4 = clocks_per_1 / 4
839 if global_options.start_quant:
840 start_quant_clocks = clocks_per_1 / global_options.start_quant
842 if global_options.duration_quant:
843 duration_quant_clocks = clocks_per_1 / global_options.duration_quant
845 allowed_tuplet_clocks = []
846 for (dur, num, den) in global_options.allowed_tuplets:
847 allowed_tuplet_clocks.append (clocks_per_1 * num / (dur * den))
850 for t in midi_dump[1]:
852 tracks.append (split_track (t))
854 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, f)
858 s = tag + '\n\\version "2.7.18"\n\n'
859 for i in range (len (tracks)):
860 s = s + dump_track (tracks[i], i)
862 s = s + '\n\\score {\n <<\n'
866 track = track_name (i)
867 item = track_first_item (t)
869 if item and item.__class__ == Note:
870 s = s + ' \\context Staff=%s \\%s\n' % (track, track)
871 elif item and item.__class__ == Text:
872 s = s + ' \\context Lyrics=%s \\%s\n' % (track, track)
877 progress (_ ("%s output to `%s'...") % ('LY', o))
882 handle = open (out_file, 'w')
888 def get_option_parser ():
889 p = ly.get_option_parser (usage='midi2ly [OPTIONS] FILE',
890 version="midi2ly (LilyPond) @TOPLEVEL_VERSION@",
891 description=_('''Convert MIDI to LilyPond source.'''))
893 p.add_option ('-a', '--absolute-pitches',
895 help=_ ("print absolute pitches"))
896 p.add_option ('-d', '--duration-quant',
898 help=_("quantise note durations on DUR"))
899 p.add_option ('-e', '--explicit-durations',
901 help=_ ("print explicit durations"))
902 p.add_option('-k', '--key', help=_ ("set key: ALT=+sharps|-flats; MINOR=1"),
903 metavar=_ ("ALT[:MINOR]"),
905 p.add_option ('-o', '--output', help=_("write output to FILE"),
908 p.add_option ('-s', '--start-quant',help= _ ("quantise note starts on DUR"),
910 p.add_option ('-t', '--allow-tuplet',
911 metavar=_ ("DUR*NUM/DEN"),
913 dest="allowed_tuplets",
914 help=_ ("allow tuplet durations DUR*NUM/DEN"),
916 p.add_option ('-V', '--verbose', help=_ ("be verbose"),
919 p.add_option ('-w', '--warranty', help=_ ("show warranty"),
922 p.add_option ('-x', '--text-lyrics', help=_("treat every text as a lyric"),
925 p.add_option_group (_ ("example"),
927 midi2ly --key=-2:1 --duration-quant=32 \
928 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
931 p.add_option_group ('bugs',
932 description='''Report bugs via http://post.gmane.org/post.php'''
933 '''?group=gmane.comp.gnu.lilypond.bugs\n''')
940 opt_parser = get_option_parser()
941 (options, args) = opt_parser.parse_args ()
943 if not args or args[0] == '-':
944 opt_parser.print_help ()
945 sys.stderr.write ('\n%s: %s %s\n' % (program_name, _ ("error: "),
946 _ ("no files specified on command line.")))
949 if options.duration_quant:
950 options.duration_quant = string.atoi (options.duration_quant)
956 (alterations, minor) = map (string.atoi, string.split (options.key + ':0', ':'))[0:2]
962 flats = - alterations
964 options.key = Key (sharps, flats, minor)
967 if options.start_quant:
968 options.start_quant = string.atoi (a)
970 options.allowed_tuplets = [map (string.atoi, a.replace ('/','*').split ('*'))
971 for a in options.allowed_tuplets]
973 global global_options
974 global_options = options
983 g = strip_extension (g, '.midi')
984 g = strip_extension (g, '.mid')
985 g = strip_extension (g, '.MID')
986 (outdir, outbase) = ('','')
990 outbase = os.path.basename (g)
991 o = os.path.join (outdir, outbase + '-midi.ly')
992 elif output_name[-1] == os.sep:
994 outbase = os.path.basename (g)
995 os.path.join (outdir, outbase + '-gen.ly')
998 (outdir, outbase) = os.path.split (o)
1000 if outdir != '.' and outdir != '':
1002 os.mkdir (outdir, 0777)