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)
59 ################################################################
64 ################################################################
65 ################ CONSTANTS
70 scale_steps = [0,2,4,5,7,9,11]
79 start_quant_clocks = 0
81 duration_quant_clocks = 0
82 allowed_tuplet_clocks = []
85 ################################################################
87 localedir = '@localedir@'
90 gettext.bindtextdomain ('lilypond', localedir)
91 gettext.textdomain ('lilypond')
97 program_name = sys.argv[0]
98 program_version = '@TOPLEVEL_VERSION@'
100 errorport = sys.stderr
103 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
107 sys.stdout.write ('\n')
108 sys.stdout.write (_ ('Copyright (c) %s by') % ' 2001--2006')
109 sys.stdout.write ('\n')
110 sys.stdout.write (' Han-Wen Nienhuys\n')
111 sys.stdout.write (' Jan Nieuwenhuizen\n')
112 sys.stdout.write ('\n\n')
113 sys.stdout.write (_ ("Distributed under terms of the GNU General Public License.") + '\n')
114 sys.stdout.write (_ ("It comes with NO WARRANTY.") + '\n')
115 sys.stdout.write ('\n')
118 errorport.write (s + '\n')
121 progress (_ ("warning: ") + s)
124 progress (_ ("error: ") + s)
125 raise _ ("Exiting ... ")
127 def system (cmd, ignore_error = 0):
128 return ly.system (cmd, ignore_error=ignore_error)
130 def strip_extension (f, ext):
131 (p, e) = os.path.splitext (f)
140 allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
141 def __init__ (self, clocks):
144 self.clocks = duration_quant_clocks
145 (self.dur, self.num, self.den) = self.dur_num_den (clocks)
147 def dur_num_den (self, clocks):
148 for i in range (len (allowed_tuplet_clocks)):
149 if clocks == allowed_tuplet_clocks[i]:
150 return global_options.allowed_tuplets[i]
152 dur = 0; num = 1; den = 1;
153 g = gcd (clocks, clocks_per_1)
155 (dur, num) = (clocks_per_1 / g, clocks / g)
156 if not dur in self.allowed_durs:
157 dur = 4; num = clocks; den = clocks_per_4
158 return (dur, num, den)
164 elif self.num == 3 and self.dur != 1:
165 s = '%d.' % (self.dur / 2)
167 s = '%d*%d' % (self.dur, self.num)
169 s = '%d*%d/%d' % (self.dur, self.num, self.den)
171 global reference_note
172 reference_note.duration = self
176 def compare (self, other):
177 return self.clocks - other.clocks
186 names = (0, 0, 1, 1, 2, 3, 3, 4, 4, 5, 5, 6)
187 alterations = (0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0)
188 alteration_names = ('eses', 'es', '', 'is' , 'isis')
189 def __init__ (self, clocks, pitch, velocity):
191 self.velocity = velocity
194 self.duration = Duration (clocks)
195 (self.octave, self.notename, self.alteration) = self.o_n_a ()
199 # minor scale: la-la (= + 5) '''
201 n = self.names[(self.pitch) % 12]
202 a = self.alterations[(self.pitch) % 12]
204 if a and global_options.key.flats:
205 a = - self.alterations[(self.pitch) % 12]
208 # By tradition, all scales now consist of a sequence
209 # of 7 notes each with a distinct name, from amongst
210 # a b c d e f g. But, minor scales have a wide
211 # second interval at the top - the 'leading note' is
212 # sharped. (Why? it just works that way! Anything
213 # else doesn't sound as good and isn't as flexible at
214 # saying things. In medieval times, scales only had 6
215 # notes to avoid this problem - the hexachords.)
217 # So, the d minor scale is d e f g a b-flat c-sharp d
218 # - using d-flat for the leading note would skip the
219 # name c and duplicate the name d. Why isn't c-sharp
220 # put in the key signature? Tradition. (It's also
221 # supposedly based on the Pythagorean theory of the
222 # cycle of fifths, but that really only applies to
223 # major scales...) Anyway, g minor is g a b-flat c d
224 # e-flat f-sharp g, and all the other flat minor keys
225 # end up with a natural leading note. And there you
228 # John Sankey <bf250@freenet.carleton.ca>
230 # Let's also do a-minor: a b c d e f gis a
234 o = self.pitch / 12 - 4
236 key = global_options.key
239 if key.sharps == 0 and key.flats == 0 \
240 and n == 5 and a == -1:
243 elif key.flats == 1 and n == 1 and a == -1:
246 elif key.flats == 2 and n == 4 and a == -1:
249 elif key.sharps == 5 and n == 4 and a == 0:
252 elif key.sharps == 6 and n == 1 and a == 0:
255 elif key.sharps == 7 and n == 5 and a == 0:
259 if key.flats >= 6 and n == 6 and a == 0:
260 n = 0; a = -1; o = o + 1
262 if key.flats >= 7 and n == 2 and a == 0:
266 if key.sharps >= 3 and n == 3 and a == 0:
269 if key.sharps >= 4 and n == 0 and a == 0:
270 n = 6; a = 1; o = o - 1
275 s = chr ((self.notename + 2) % 7 + ord ('a'))
276 return 'Note(%s %s)' % (s, self.duration.dump())
278 def dump (self, dump_dur = 1):
279 global reference_note
280 s = chr ((self.notename + 2) % 7 + ord ('a'))
281 s = s + self.alteration_names[self.alteration + 2]
282 if global_options.absolute_pitches:
285 delta = self.pitch - reference_note.pitch
286 commas = sign (delta) * (abs (delta) / 12)
288 * (self.notename - reference_note.notename) + 7) \
290 or ((self.notename == reference_note.notename) \
291 and (abs (delta) > 4) and (abs (delta) < 12)):
292 commas = commas + sign (delta)
297 s = s + "," * -commas
299 ## FIXME: compile fix --jcn
300 if dump_dur and (global_options.explicit_durations \
301 or Duration.compare (self.duration,
302 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):
368 if self.sharps and self.flats:
372 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
374 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
377 name = chr ((k + 2) % 7 + ord ('a'))
379 name = chr ((k + 2) % 7 + ord ('a'))
381 # fis cis gis dis ais eis bis
382 sharps = (2, 4, 6, 1, 3, 5, 7)
383 # bes es as des ges ces fes
384 flats = (6, 4, 2, 7, 5, 3, 1)
387 if flats[k] <= self.flats:
390 if sharps[k] <= self.sharps:
394 name = name + Note.alteration_names[a + 2]
402 return '\n\n ' + s + '\n '
410 'SEQUENCE_TRACK_NAME',
416 def __init__ (self, type, text):
422 # urg, we should be sure that we're in a lyrics staff
423 if self.type == midi.LYRIC:
424 s = '"%s"' % self.text
425 d = Duration (self.clocks)
426 if global_options.explicit_durations \
427 or Duration.compare (d,
428 reference_note.duration):
429 s = s + Duration (self.clocks).dump ()
432 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
436 return 'Text(%d=%s)' % (self.type, self.text)
440 def split_track (track):
447 if data[0] > 0x7f and data[0] < 0xf0:
449 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
459 for v in chs.values ():
460 events = events_on_channel (v)
461 thread = unthread_notes (events)
463 threads.append (thread)
467 def quantise_clocks (clocks, quant):
468 q = int (clocks / quant) * quant
470 for tquant in allowed_tuplet_clocks:
471 if int (clocks / tquant) * tquant == clocks:
473 if 2 * (clocks - q) > quant:
477 def end_note (pitches, notes, t, e):
479 (lt, vel) = pitches[e]
489 if duration_quant_clocks:
490 d = quantise_clocks (d, duration_quant_clocks)
492 d = duration_quant_clocks
495 (lt, Note (d, e, vel)))
500 def events_on_channel (channel):
510 if start_quant_clocks:
511 t = quantise_clocks (t, start_quant_clocks)
514 if e[1][0] == midi.NOTE_OFF \
515 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0):
516 end_note (pitches, notes, t, e[1][1])
518 elif e[1][0] == midi.NOTE_ON:
519 if not pitches.has_key (e[1][1]):
520 pitches[e[1][1]] = (t, e[1][2])
522 # all include ALL_NOTES_OFF
523 elif e[1][0] >= midi.ALL_SOUND_OFF \
524 and e[1][0] <= midi.POLY_MODE_ON:
525 for i in pitches.keys ():
526 end_note (pitches, notes, t, i)
528 elif e[1][0] == midi.META_EVENT:
529 if e[1][1] == midi.END_OF_TRACK:
530 for i in pitches.keys ():
531 end_note (pitches, notes, t, i)
534 elif e[1][1] == midi.SET_TEMPO:
535 (u0, u1, u2) = map (ord, e[1][2])
536 us_per_4 = u2 + 256 * (u1 + 256 * u0)
537 seconds_per_1 = us_per_4 * 4 / 1e6
538 events.append ((t, Tempo (seconds_per_1)))
539 elif e[1][1] == midi.TIME_SIGNATURE:
540 (num, dur, clocks4, count32) = map (ord, e[1][2])
542 events.append ((t, Time (num, den)))
543 elif e[1][1] == midi.KEY_SIGNATURE:
544 (alterations, minor) = map (ord, e[1][2])
547 if alterations < 127:
550 flats = 256 - alterations
552 k = Key (sharps, flats, minor)
553 events.append ((t, k))
555 # ugh, must set key while parsing
556 # because Note init uses key
557 # Better do Note.calc () at dump time?
561 elif e[1][1] == midi.LYRIC \
562 or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT):
564 last_lyric.clocks = t - last_time
565 events.append ((last_time, last_lyric))
567 last_lyric = Text (midi.LYRIC, e[1][2])
569 elif e[1][1] >= midi.SEQUENCE_NUMBER \
570 and e[1][1] <= midi.CUE_POINT:
571 events.append ((t, Text (e[1][1], e[1][2])))
573 if global_options.verbose:
574 sys.stderr.write ("SKIP: %s\n" % `e`)
577 if global_options.verbose:
578 sys.stderr.write ("SKIP: %s\n" % `e`)
582 # last_lyric.clocks = t - last_time
584 last_lyric.clocks = clocks_per_4
585 events.append ((last_time, last_lyric))
590 if i < len (events) and notes[0][0] >= events[i][0]:
593 events.insert (i, notes[0])
597 def unthread_notes (channel):
606 if e[1].__class__ == Note \
607 and ((t == start_busy_t \
608 and e[1].clocks + t == end_busy_t) \
612 end_busy_t = t + e[1].clocks
613 elif e[1].__class__ == Time \
614 or e[1].__class__ == Key \
615 or e[1].__class__ == Text \
616 or e[1].__class__ == Tempo:
620 threads.append (thread)
635 def dump_skip (skip, clocks):
636 return skip + Duration (clocks).dump () + ' '
645 if i.__class__ == Note:
650 s = s + dump (notes[0])
651 elif len (notes) > 1:
652 global reference_note
654 s = s + notes[0].dump (dump_dur = 0)
657 s = s + i.dump (dump_dur = 0 )
660 s = s + notes[0].duration.dump() + ' '
664 def dump_bar_line (last_bar_t, t, bar_count):
666 bar_t = time.bar_clocks ()
667 if t - last_bar_t >= bar_t:
668 bar_count = bar_count + (t - last_bar_t) / bar_t
670 if t - last_bar_t == bar_t:
671 s = '|\n %% %d\n ' % bar_count
674 # urg, this will barf at meter changes
675 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
677 return (s, last_bar_t, bar_count)
680 def dump_channel (thread, skip):
681 global key, reference_note, time
685 # urg LilyPond doesn't start at c4, but
686 # remembers from previous tracks!
687 # reference_note = Note (clocks_per_4, 4*12, 0)
688 reference_note = Note (0, 4*12, 0)
694 if last_e and last_e[0] == e[0]:
698 chs.append ((last_e[0], ch))
705 chs.append ((last_e[0], ch))
715 i = string.rfind (lines[-1], '\n') + 1
716 if len (lines[-1][i:]) > LINE_BELL:
720 lines[-1] = lines[-1] + dump_skip (skip, t-last_t)
722 errorport.write ('BUG: time skew')
724 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
726 lines[-1] = lines[-1] + s
728 lines[-1] = lines[-1] + dump_chord (ch[1])
732 if i.clocks > clocks:
737 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
739 lines[-1] = lines[-1] + s
741 return string.join (lines, '\n ') + '\n'
744 return 'track%c' % (i + ord ('A'))
746 def channel_name (i):
747 return 'channel%c' % (i + ord ('A'))
749 def dump_track (channels, n):
751 track = track_name (n)
752 clef = guess_clef (channels)
754 for i in range (len (channels)):
755 channel = channel_name (i)
756 item = thread_first_item (channels[i])
758 if item and item.__class__ == Note:
760 s = s + '%s = ' % (track + channel)
761 if not global_options.absolute_pitches:
762 s = s + '\\relative c '
763 elif item and item.__class__ == Text:
765 s = s + '%s = \\lyricmode ' % (track + channel)
768 s = s + '%s = ' % (track + channel)
770 s = s + ' ' + dump_channel (channels[i][0], skip)
773 s = s + '%s = <<\n' % track
776 s = s + clef.dump () + '\n'
778 for i in range (len (channels)):
779 channel = channel_name (i)
780 item = thread_first_item (channels[i])
781 if item and item.__class__ == Text:
782 s = s + ' \\context Lyrics = %s \\%s\n' % (channel,
785 s = s + ' \\context Voice = %s \\%s\n' % (channel,
790 def thread_first_item (thread):
793 if (event[1].__class__ == Note
794 or (event[1].__class__ == Text
795 and event[1].type == midi.LYRIC)):
800 def track_first_item (track):
802 first = thread_first_item (thread)
807 def guess_clef (track):
813 if event[1].__class__ == Note:
815 p = p + event[1].pitch
816 if i and p / i <= 3*12:
818 elif i and p / i <= 5*12:
820 elif i and p / i >= 7*12:
826 def convert_midi (in_file, out_file):
827 global clocks_per_1, clocks_per_4, key
828 global start_quant_clocks
829 global duration_quant_clocks
830 global allowed_tuplet_clocks
832 str = open (in_file).read ()
833 midi_dump = midi.parse (str)
835 clocks_per_1 = midi_dump[0][1]
836 clocks_per_4 = clocks_per_1 / 4
838 if global_options.start_quant:
839 start_quant_clocks = clocks_per_1 / global_options.start_quant
841 if global_options.duration_quant:
842 duration_quant_clocks = clocks_per_1 / global_options.duration_quant
844 allowed_tuplet_clocks = []
845 for (dur, num, den) in global_options.allowed_tuplets:
846 allowed_tuplet_clocks.append (clocks_per_1 * num / (dur * den))
849 for t in midi_dump[1]:
851 tracks.append (split_track (t))
853 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, f)
857 s = tag + '\n\\version "2.7.18"\n\n'
858 for i in range (len (tracks)):
859 s = s + dump_track (tracks[i], i)
861 s = s + '\n\\score {\n <<\n'
865 track = track_name (i)
866 item = track_first_item (t)
868 if item and item.__class__ == Note:
869 s = s + ' \\context Staff=%s \\%s\n' % (track, track)
870 elif item and item.__class__ == Text:
871 s = s + ' \\context Lyrics=%s \\%s\n' % (track, track)
876 progress (_ ("%s output to `%s'...") % ('LY', o))
881 handle = open (out_file, 'w')
887 def get_option_parser ():
888 p = ly.get_option_parser (usage='midi2ly [OPTIONS] FILE',
889 version="midi2ly (LilyPond) @TOPLEVEL_VERSION@",
890 description=_('''Convert MIDI to LilyPond source.'''))
892 p.add_option ('-a', '--absolute-pitches',
894 help=_ ("print absolute pitches"))
895 p.add_option ('-d', '--duration-quant',
897 help=_("quantise note durations on DUR"))
898 p.add_option ('-e', '--explicit-durations',
900 help=_ ("print explicit durations"))
901 p.add_option('-k', '--key', help=_ ("set key: ALT=+sharps|-flats; MINOR=1"),
902 metavar=_ ("ALT[:MINOR]"),
904 p.add_option ('-o', '--output', help=_("write output to FILE"),
907 p.add_option ('-s', '--start-quant',help= _ ("quantise note starts on DUR"),
909 p.add_option ('-t', '--allow-tuplet',
910 metavar=_ ("DUR*NUM/DEN"),
912 dest="allowed_tuplets",
913 help=_ ("allow tuplet durations DUR*NUM/DEN"),
915 p.add_option ('-V', '--verbose', help=_ ("be verbose"),
918 p.add_option ('-w', '--warranty', help=_ ("show warranty"),
921 p.add_option ('-x', '--text-lyrics', help=_("treat every text as a lyric"),
924 p.add_option_group (_ ("example"),
926 midi2ly --key=-2:1 --duration-quant=32 \
927 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
930 p.add_option_group ('bugs',
931 description='''Report bugs via http://post.gmane.org/post.php'''
932 '''?group=gmane.comp.gnu.lilypond.bugs\n''')
939 opt_parser = get_option_parser()
940 (options, args) = opt_parser.parse_args ()
942 if not args or args[0] == '-':
943 opt_parser.print_help ()
944 sys.stderr.write ('\n%s: %s %s\n' % (program_name, _ ("error: "),
945 _ ("no files specified on command line.")))
948 if options.duration_quant:
949 options.duration_quant = string.atoi (options.duration_quant)
955 (alterations, minor) = map (string.atoi, string.split (options.key + ':0', ':'))[0:2]
961 flats = - alterations
963 options.key = Key (sharps, flats, minor)
966 if options.start_quant:
967 options.start_quant = string.atoi (a)
969 options.allowed_tuplets = [map (string.atoi, a.replace ('/','*').split ('*'))
970 for a in options.allowed_tuplets]
972 global global_options
973 global_options = options
982 g = strip_extension (g, '.midi')
983 g = strip_extension (g, '.mid')
984 g = strip_extension (g, '.MID')
985 (outdir, outbase) = ('','')
989 outbase = os.path.basename (g)
990 o = os.path.join (outdir, outbase + '-midi.ly')
991 elif output_name[-1] == os.sep:
993 outbase = os.path.basename (g)
994 os.path.join (outdir, outbase + '-gen.ly')
997 (outdir, outbase) = os.path.split (o)
999 if outdir != '.' and outdir != '':
1001 os.mkdir (outdir, 0777)