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
28 ################################################################
29 # Users of python modules should include this snippet.
31 libdir = '@local_lilypond_libdir@'
32 if not os.path.isdir (libdir):
33 libdir = '@lilypond_libdir@'
36 datadir = '@local_lilypond_datadir@'
37 if os.environ.has_key ('LILYPONDPREFIX'):
38 datadir = os.environ['LILYPONDPREFIX']
39 while datadir[-1] == os.sep:
41 libdir = datadir.replace ('/share/', '/lib/')
43 if os.path.exists (os.path.join (datadir, 'lib/lilypond/@TOPLEVEL_VERSION@/')):
44 libdir = os.path.join (libdir, 'lib/lilypond/@TOPLEVEL_VERSION@/')
46 if os.path.exists (os.path.join (datadir, 'lib/lilypond/current/')):
47 libdir = os.path.join (libdir, 'lib/lilypond/current/')
49 sys.path.insert (0, os.path.join (libdir, 'python'))
51 # dynamic relocation, for GUB binaries.
52 bindir = os.path.split (sys.argv[0])[0]
54 for prefix_component in ['share', 'lib']:
55 datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % prefix_component)
56 sys.path.insert (0, datadir)
61 ################################################################
62 ################ CONSTANTS
67 scale_steps = [0,2,4,5,7,9,11]
76 start_quant_clocks = 0
78 duration_quant_clocks = 0
79 allowed_tuplet_clocks = []
82 ################################################################
84 localedir = '@localedir@'
87 gettext.bindtextdomain ('lilypond', localedir)
88 gettext.textdomain ('lilypond')
94 program_name = sys.argv[0]
95 program_version = '@TOPLEVEL_VERSION@'
97 errorport = sys.stderr
100 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
104 sys.stdout.write ('''
113 _('Distributed under terms of the GNU General Public License.'),
114 _('It comes with NO WARRANTY.')))
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 self.duration.compare (reference_note.duration)):
302 s = s + self.duration.dump ()
304 reference_note = self
311 def __init__ (self, num, den):
316 def bar_clocks (self):
317 return clocks_per_1 * self.num / self.den
320 return 'Time(%d/%d)' % (self.num, self.den)
325 return '\n ' + '\\time %d/%d ' % (self.num, self.den) + '\n '
328 def __init__ (self, seconds_per_1):
330 self.seconds_per_1 = seconds_per_1
333 return 'Tempo(%d)' % self.bpm ()
336 return 4 * 60 / self.seconds_per_1
339 return '\n ' + '\\tempo 4 = %d ' % (self.bpm()) + '\n '
342 clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
343 def __init__ (self, type):
347 return 'Clef(%s)' % self.clefs[self.type]
350 return '\n \\clef %s\n ' % self.clefs[self.type]
353 key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
354 key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
356 def __init__ (self, sharps, flats, minor):
363 global_options.key = self
366 if self.sharps and self.flats:
370 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
372 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
375 name = chr ((k + 2) % 7 + ord ('a'))
377 name = chr ((k + 2) % 7 + ord ('a'))
379 # fis cis gis dis ais eis bis
380 sharps = (2, 4, 6, 1, 3, 5, 7)
381 # bes es as des ges ces fes
382 flats = (6, 4, 2, 7, 5, 3, 1)
385 if flats[k] <= self.flats:
388 if sharps[k] <= self.sharps:
392 name = name + Note.alteration_names[a + 2]
400 return '\n\n ' + s + '\n '
408 'SEQUENCE_TRACK_NAME',
414 def __init__ (self, type, text):
420 # urg, we should be sure that we're in a lyrics staff
421 if self.type == midi.LYRIC:
422 s = '"%s"' % self.text
423 d = Duration (self.clocks)
424 if global_options.explicit_durations \
425 or d.compare (reference_note.duration):
426 s = s + Duration (self.clocks).dump ()
429 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
433 return 'Text(%d=%s)' % (self.type, self.text)
437 def split_track (track):
444 if data[0] > 0x7f and data[0] < 0xf0:
446 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
456 for v in chs.values ():
457 events = events_on_channel (v)
458 thread = unthread_notes (events)
460 threads.append (thread)
464 def quantise_clocks (clocks, quant):
465 q = int (clocks / quant) * quant
467 for tquant in allowed_tuplet_clocks:
468 if int (clocks / tquant) * tquant == clocks:
470 if 2 * (clocks - q) > quant:
474 def end_note (pitches, notes, t, e):
476 (lt, vel) = pitches[e]
486 if duration_quant_clocks:
487 d = quantise_clocks (d, duration_quant_clocks)
489 d = duration_quant_clocks
492 (lt, Note (d, e, vel)))
497 def events_on_channel (channel):
507 if start_quant_clocks:
508 t = quantise_clocks (t, start_quant_clocks)
511 if e[1][0] == midi.NOTE_OFF \
512 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0):
513 end_note (pitches, notes, t, e[1][1])
515 elif e[1][0] == midi.NOTE_ON:
516 if not pitches.has_key (e[1][1]):
517 pitches[e[1][1]] = (t, e[1][2])
519 # all include ALL_NOTES_OFF
520 elif e[1][0] >= midi.ALL_SOUND_OFF \
521 and e[1][0] <= midi.POLY_MODE_ON:
522 for i in pitches.keys ():
523 end_note (pitches, notes, t, i)
525 elif e[1][0] == midi.META_EVENT:
526 if e[1][1] == midi.END_OF_TRACK:
527 for i in pitches.keys ():
528 end_note (pitches, notes, t, i)
531 elif e[1][1] == midi.SET_TEMPO:
532 (u0, u1, u2) = map (ord, e[1][2])
533 us_per_4 = u2 + 256 * (u1 + 256 * u0)
534 seconds_per_1 = us_per_4 * 4 / 1e6
535 events.append ((t, Tempo (seconds_per_1)))
536 elif e[1][1] == midi.TIME_SIGNATURE:
537 (num, dur, clocks4, count32) = map (ord, e[1][2])
539 events.append ((t, Time (num, den)))
540 elif e[1][1] == midi.KEY_SIGNATURE:
541 (alterations, minor) = map (ord, e[1][2])
544 if alterations < 127:
547 flats = 256 - alterations
549 k = Key (sharps, flats, minor)
550 events.append ((t, k))
552 # ugh, must set key while parsing
553 # because Note init uses key
554 # Better do Note.calc () at dump time?
555 global_options.key = k
557 elif e[1][1] == midi.LYRIC \
558 or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT):
560 last_lyric.clocks = t - last_time
561 events.append ((last_time, last_lyric))
563 last_lyric = Text (midi.LYRIC, e[1][2])
565 elif e[1][1] >= midi.SEQUENCE_NUMBER \
566 and e[1][1] <= midi.CUE_POINT:
567 events.append ((t, Text (e[1][1], e[1][2])))
569 if global_options.verbose:
570 sys.stderr.write ("SKIP: %s\n" % `e`)
573 if global_options.verbose:
574 sys.stderr.write ("SKIP: %s\n" % `e`)
578 # last_lyric.clocks = t - last_time
580 last_lyric.clocks = clocks_per_4
581 events.append ((last_time, last_lyric))
586 if i < len (events) and notes[0][0] >= events[i][0]:
589 events.insert (i, notes[0])
593 def unthread_notes (channel):
602 if e[1].__class__ == Note \
603 and ((t == start_busy_t \
604 and e[1].clocks + t == end_busy_t) \
608 end_busy_t = t + e[1].clocks
609 elif e[1].__class__ == Time \
610 or e[1].__class__ == Key \
611 or e[1].__class__ == Text \
612 or e[1].__class__ == Tempo:
616 threads.append (thread)
631 def dump_skip (skip, clocks):
632 return skip + Duration (clocks).dump () + ' '
641 if i.__class__ == Note:
646 s = s + dump (notes[0])
647 elif len (notes) > 1:
648 global reference_note
650 s = s + notes[0].dump (dump_dur = 0)
653 s = s + i.dump (dump_dur = 0 )
656 s = s + notes[0].duration.dump() + ' '
660 def dump_bar_line (last_bar_t, t, bar_count):
662 bar_t = time.bar_clocks ()
663 if t - last_bar_t >= bar_t:
664 bar_count = bar_count + (t - last_bar_t) / bar_t
666 if t - last_bar_t == bar_t:
667 s = '|\n %% %d\n ' % bar_count
670 # urg, this will barf at meter changes
671 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
673 return (s, last_bar_t, bar_count)
676 def dump_channel (thread, skip):
677 global reference_note, time
679 global_options.key = Key (0, 0, 0)
681 # urg LilyPond doesn't start at c4, but
682 # remembers from previous tracks!
683 # reference_note = Note (clocks_per_4, 4*12, 0)
684 reference_note = Note (0, 4*12, 0)
690 if last_e and last_e[0] == e[0]:
694 chs.append ((last_e[0], ch))
701 chs.append ((last_e[0], ch))
711 i = string.rfind (lines[-1], '\n') + 1
712 if len (lines[-1][i:]) > LINE_BELL:
716 lines[-1] = lines[-1] + dump_skip (skip, t-last_t)
718 errorport.write ('BUG: time skew')
720 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
722 lines[-1] = lines[-1] + s
724 lines[-1] = lines[-1] + dump_chord (ch[1])
728 if i.clocks > clocks:
733 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
735 lines[-1] = lines[-1] + s
737 return string.join (lines, '\n ') + '\n'
740 return 'track%c' % (i + ord ('A'))
742 def channel_name (i):
743 return 'channel%c' % (i + ord ('A'))
745 def dump_track (channels, n):
747 track = track_name (n)
748 clef = guess_clef (channels)
750 for i in range (len (channels)):
751 channel = channel_name (i)
752 item = thread_first_item (channels[i])
754 if item and item.__class__ == Note:
756 s = s + '%s = ' % (track + channel)
757 if not global_options.absolute_pitches:
758 s = s + '\\relative c '
759 elif item and item.__class__ == Text:
761 s = s + '%s = \\lyricmode ' % (track + channel)
764 s = s + '%s = ' % (track + channel)
766 s = s + ' ' + dump_channel (channels[i][0], skip)
769 s = s + '%s = <<\n' % track
772 s = s + clef.dump () + '\n'
774 for i in range (len (channels)):
775 channel = channel_name (i)
776 item = thread_first_item (channels[i])
777 if item and item.__class__ == Text:
778 s = s + ' \\context Lyrics = %s \\%s\n' % (channel,
781 s = s + ' \\context Voice = %s \\%s\n' % (channel,
786 def thread_first_item (thread):
789 if (event[1].__class__ == Note
790 or (event[1].__class__ == Text
791 and event[1].type == midi.LYRIC)):
796 def track_first_item (track):
798 first = thread_first_item (thread)
803 def guess_clef (track):
809 if event[1].__class__ == Note:
811 p = p + event[1].pitch
812 if i and p / i <= 3*12:
814 elif i and p / i <= 5*12:
816 elif i and p / i >= 7*12:
822 def convert_midi (in_file, out_file):
823 global clocks_per_1, clocks_per_4, key
824 global start_quant_clocks
825 global duration_quant_clocks
826 global allowed_tuplet_clocks
828 str = open (in_file).read ()
829 midi_dump = midi.parse (str)
831 clocks_per_1 = midi_dump[0][1]
832 clocks_per_4 = clocks_per_1 / 4
834 if global_options.start_quant:
835 start_quant_clocks = clocks_per_1 / global_options.start_quant
837 if global_options.duration_quant:
838 duration_quant_clocks = clocks_per_1 / global_options.duration_quant
840 allowed_tuplet_clocks = []
841 for (dur, num, den) in global_options.allowed_tuplets:
842 allowed_tuplet_clocks.append (clocks_per_1 / den)
845 for t in midi_dump[1]:
846 global_options.key = Key (0, 0, 0)
847 tracks.append (split_track (t))
849 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, in_file)
853 s = tag + '\n\\version "2.7.18"\n\n'
854 for i in range (len (tracks)):
855 s = s + dump_track (tracks[i], i)
857 s = s + '\n\\score {\n <<\n'
861 track = track_name (i)
862 item = track_first_item (t)
864 if item and item.__class__ == Note:
865 s = s + ' \\context Staff=%s \\%s\n' % (track, track)
866 elif item and item.__class__ == Text:
867 s = s + ' \\context Lyrics=%s \\%s\n' % (track, track)
872 progress (_ ("%s output to `%s'...") % ('LY', out_file))
877 handle = open (out_file, 'w')
883 def get_option_parser ():
884 p = ly.get_option_parser (usage='midi2ly [OPTIONS] FILE',
885 version="midi2ly (LilyPond) @TOPLEVEL_VERSION@",
886 description=_('''Convert MIDI to LilyPond source.'''))
888 p.add_option ('-a', '--absolute-pitches',
890 help=_ ("print absolute pitches"))
891 p.add_option ('-d', '--duration-quant',
893 help=_("quantise note durations on DUR"))
894 p.add_option ('-e', '--explicit-durations',
896 help=_ ("print explicit durations"))
897 p.add_option('-k', '--key', help=_ ("set key: ALT=+sharps|-flats; MINOR=1"),
898 metavar=_ ("ALT[:MINOR]"),
900 p.add_option ('-o', '--output', help=_("write output to FILE"),
903 p.add_option ('-s', '--start-quant',help= _ ("quantise note starts on DUR"),
905 p.add_option ('-t', '--allow-tuplet',
906 metavar=_ ("DUR*NUM/DEN"),
908 dest="allowed_tuplets",
909 help=_ ("allow tuplet durations DUR*NUM/DEN"),
911 p.add_option ('-V', '--verbose', help=_("be verbose"),
914 p.add_option ('-w', '--warranty', help=_("show warranty"),
917 p.add_option ('-x', '--text-lyrics', help=_("treat every text as a lyric"),
920 p.add_option_group (_ ("example"),
922 midi2ly --key=-2:1 --duration-quant=32 \
923 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
926 p.add_option_group ('bugs',
927 description='''Report bugs via http://post.gmane.org/post.php'''
928 '''?group=gmane.comp.gnu.lilypond.bugs\n''')
935 opt_parser = get_option_parser()
936 (options, args) = opt_parser.parse_args ()
938 if not args or args[0] == '-':
939 opt_parser.print_help ()
940 sys.stderr.write ('\n%s: %s %s\n' % (program_name, _ ("error: "),
941 _ ("no files specified on command line.")))
944 if options.duration_quant:
945 options.duration_quant = int (options.duration_quant)
951 (alterations, minor) = map (int, string.split (options.key + ':0', ':'))[0:2]
957 flats = - alterations
959 options.key = Key (sharps, flats, minor)
962 if options.start_quant:
963 options.start_quant = int (options.start_quant)
965 options.allowed_tuplets = [map (int, a.replace ('/','*').split ('*'))
966 for a in options.allowed_tuplets]
968 global global_options
969 global_options = options
978 g = strip_extension (g, '.midi')
979 g = strip_extension (g, '.mid')
980 g = strip_extension (g, '.MID')
981 (outdir, outbase) = ('','')
985 outbase = os.path.basename (g)
986 o = os.path.join (outdir, outbase + '-midi.ly')
987 elif output_name[-1] == os.sep:
989 outbase = os.path.basename (g)
990 os.path.join (outdir, outbase + '-gen.ly')
993 (outdir, outbase) = os.path.split (o)
995 if outdir != '.' and outdir != '':
997 os.mkdir (outdir, 0777)
1002 if __name__ == '__main__':