3 # midi2ly.py -- LilyPond midi import script
5 # This file is part of LilyPond, the GNU music typesetter.
7 # Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
8 # Jan Nieuwenhuizen <janneke@gnu.org>
10 # LilyPond is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
15 # LilyPond is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
26 * test on weird and unquantised midi input (lily-devel)
27 * update doc and manpage
29 * simply insert clef changes whenever too many ledger lines
30 [to avoid tex capacity exceeded]
31 * do not ever quant skips
32 * better lyrics handling
33 * [see if it is feasible to] move ly-classes to library for use in
34 other converters, while leaving midi specific stuff here
48 ################################################################
53 scale_steps = [0, 2, 4, 5, 7, 9, 11]
61 start_quant_clocks = 0
63 duration_quant_clocks = 0
64 allowed_tuplet_clocks = []
67 ################################################################
70 program_name = sys.argv[0]
71 program_version = '@TOPLEVEL_VERSION@'
73 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
74 'Han-Wen Nienhuys <hanwen@xs4all.nl>')
76 errorport = sys.stderr
79 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
83 ly.encoded_write (sys.stdout, '''
90 ''' % ( _ ('Copyright (c) %s by') % '1998--2011',
92 _ ('Distributed under terms of the GNU General Public License.'),
93 _ ('It comes with NO WARRANTY.')))
96 ly.encoded_write (errorport, s + '\n')
99 progress (_ ("warning: ") + s)
102 progress (_ ("error: ") + s)
103 raise Exception (_ ("Exiting... "))
107 progress ("debug: " + s)
109 def system (cmd, ignore_error = 0):
110 return ly.system (cmd, ignore_error=ignore_error)
112 def strip_extension (f, ext):
113 (p, e) = os.path.splitext (f)
120 allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
121 def __init__ (self, clocks):
124 self.clocks = duration_quant_clocks
125 (self.dur, self.num, self.den) = self.dur_num_den (clocks)
127 def dur_num_den (self, clocks):
128 for i in range (len (allowed_tuplet_clocks)):
129 if clocks == allowed_tuplet_clocks[i]:
130 return global_options.allowed_tuplets[i]
132 dur = 0; num = 1; den = 1;
133 g = gcd (clocks, clocks_per_1)
135 (dur, num) = (clocks_per_1 / g, clocks / g)
136 if not dur in self.allowed_durs:
137 dur = 4; num = clocks; den = clocks_per_4
138 return (dur, num, den)
144 elif self.num == 3 and self.dur != 1:
145 s = '%d.' % (self.dur / 2)
147 s = '%d*%d' % (self.dur, self.num)
149 s = '%d*%d/%d' % (self.dur, self.num, self.den)
151 global reference_note
152 reference_note.duration = self
156 def compare (self, other):
157 return self.clocks - other.clocks
166 names = (0, 0, 1, 1, 2, 3, 3, 4, 4, 5, 5, 6)
167 alterations = (0, 1, 0, 1, 0, 0, 1, 0, 1, 0, 1, 0)
168 alteration_names = ('eses', 'es', '', 'is' , 'isis')
169 def __init__ (self, clocks, pitch, velocity):
171 self.velocity = velocity
174 self.duration = Duration (clocks)
175 (self.octave, self.notename, self.alteration) = self.o_n_a ()
179 # minor scale: la-la (= + 5) '''
181 n = self.names[(self.pitch) % 12]
182 a = self.alterations[(self.pitch) % 12]
184 if a and global_options.key.flats:
185 a = - self.alterations[(self.pitch) % 12]
188 # By tradition, all scales now consist of a sequence
189 # of 7 notes each with a distinct name, from amongst
190 # a b c d e f g. But, minor scales have a wide
191 # second interval at the top - the 'leading note' is
192 # sharped. (Why? it just works that way! Anything
193 # else doesn't sound as good and isn't as flexible at
194 # saying things. In medieval times, scales only had 6
195 # notes to avoid this problem - the hexachords.)
197 # So, the d minor scale is d e f g a b-flat c-sharp d
198 # - using d-flat for the leading note would skip the
199 # name c and duplicate the name d. Why isn't c-sharp
200 # put in the key signature? Tradition. (It's also
201 # supposedly based on the Pythagorean theory of the
202 # cycle of fifths, but that really only applies to
203 # major scales...) Anyway, g minor is g a b-flat c d
204 # e-flat f-sharp g, and all the other flat minor keys
205 # end up with a natural leading note. And there you
208 # John Sankey <bf250@freenet.carleton.ca>
210 # Let's also do a-minor: a b c d e f gis a
214 o = self.pitch / 12 - 4
216 key = global_options.key
219 if (key.sharps == 0 and key.flats == 0
220 and n == 5 and a == -1):
223 elif key.flats == 1 and n == 1 and a == -1:
226 elif key.flats == 2 and n == 4 and a == -1:
229 elif key.sharps == 5 and n == 4 and a == 0:
232 elif key.sharps == 6 and n == 1 and a == 0:
235 elif key.sharps == 7 and n == 5 and a == 0:
239 if key.flats >= 6 and n == 6 and a == 0:
240 n = 0; a = -1; o = o + 1
242 if key.flats >= 7 and n == 2 and a == 0:
246 if key.sharps >= 3 and n == 3 and a == 0:
249 if key.sharps >= 4 and n == 0 and a == 0:
250 n = 6; a = 1; o = o - 1
255 s = chr ((self.notename + 2) % 7 + ord ('a'))
256 return 'Note(%s %s)' % (s, self.duration.dump ())
258 def dump (self, dump_dur=True):
259 global reference_note
260 s = chr ((self.notename + 2) % 7 + ord ('a'))
261 s = s + self.alteration_names[self.alteration + 2]
262 if global_options.absolute_pitches:
265 delta = self.pitch - reference_note.pitch
266 commas = sign (delta) * (abs (delta) / 12)
268 * (self.notename - reference_note.notename) + 7)
270 or ((self.notename == reference_note.notename)
271 and (abs (delta) > 4) and (abs (delta) < 12))):
272 commas = commas + sign (delta)
277 s = s + "," * -commas
280 and self.duration.compare (reference_note.duration))
281 or global_options.explicit_durations):
282 s = s + self.duration.dump ()
284 reference_note = self
291 def __init__ (self, num, den):
296 def bar_clocks (self):
297 return clocks_per_1 * self.num / self.den
300 return 'Time(%d/%d)' % (self.num, self.den)
305 return '\n ' + '\\time %d/%d ' % (self.num, self.den) + '\n '
308 def __init__ (self, seconds_per_1):
310 self.seconds_per_1 = seconds_per_1
313 return 'Tempo(%d)' % self.bpm ()
316 return 4 * 60 / self.seconds_per_1
319 return '\n ' + '\\tempo 4 = %d ' % (self.bpm ()) + '\n '
322 clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
323 def __init__ (self, type):
327 return 'Clef(%s)' % self.clefs[self.type]
330 return '\n \\clef %s\n ' % self.clefs[self.type]
333 key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
334 key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
336 def __init__ (self, sharps, flats, minor):
343 global_options.key = self
346 if self.sharps and self.flats:
350 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
352 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
355 name = chr ((k + 2) % 7 + ord ('a'))
357 name = chr ((k + 2) % 7 + ord ('a'))
359 # fis cis gis dis ais eis bis
360 sharps = (2, 4, 6, 1, 3, 5, 7)
361 # bes es as des ges ces fes
362 flats = (6, 4, 2, 7, 5, 3, 1)
365 if flats[k] <= self.flats:
368 if sharps[k] <= self.sharps:
372 name = name + Note.alteration_names[a + 2]
380 return '\n\n ' + s + '\n '
388 'SEQUENCE_TRACK_NAME',
394 def __init__ (self, type, text):
400 # urg, we should be sure that we're in a lyrics staff
401 if self.type == midi.LYRIC:
402 s = '"%s"' % self.text
403 d = Duration (self.clocks)
404 if (global_options.explicit_durations
405 or d.compare (reference_note.duration)):
406 s = s + Duration (self.clocks).dump ()
408 elif self.text and self.type == midi.SEQUENCE_TRACK_NAME:
409 text = self.text.replace ('(MIDI)', '').strip ()
411 s = '\n \\set Staff.instrumentName = "%(text)s"\n ' % locals ()
413 s = '\n % [' + self.text_types[self.type] + '] ' + self.text + '\n '
417 return 'Text(%d=%s)' % (self.type, self.text)
421 def split_track (track):
428 if data[0] > 0x7f and data[0] < 0xf0:
430 e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
440 for v in chs.values ():
441 events = events_on_channel (v)
442 t = unthread_notes (events)
447 def quantise_clocks (clocks, quant):
448 q = int (clocks / quant) * quant
450 for tquant in allowed_tuplet_clocks:
451 if int (clocks / tquant) * tquant == clocks:
453 if 2 * (clocks - q) > quant:
457 def end_note (pitches, notes, t, e):
459 (lt, vel) = pitches[e]
469 if duration_quant_clocks:
470 d = quantise_clocks (d, duration_quant_clocks)
472 d = duration_quant_clocks
475 (lt, Note (d, e, vel)))
480 def events_on_channel (channel):
490 if start_quant_clocks:
491 t = quantise_clocks (t, start_quant_clocks)
494 if (e[1][0] == midi.NOTE_OFF
495 or (e[1][0] == midi.NOTE_ON and e[1][2] == 0)):
496 debug ('%d: NOTE OFF: %s' % (t, e[1][1]))
498 debug (' ...treated as OFF')
499 end_note (pitches, notes, t, e[1][1])
501 elif e[1][0] == midi.NOTE_ON:
502 if not pitches.has_key (e[1][1]):
503 debug ('%d: NOTE ON: %s' % (t, e[1][1]))
504 pitches[e[1][1]] = (t, e[1][2])
508 # all include ALL_NOTES_OFF
509 elif (e[1][0] >= midi.ALL_SOUND_OFF
510 and e[1][0] <= midi.POLY_MODE_ON):
512 end_note (pitches, notes, t, i)
514 elif e[1][0] == midi.META_EVENT:
515 if e[1][1] == midi.END_OF_TRACK:
517 end_note (pitches, notes, t, i)
520 elif e[1][1] == midi.SET_TEMPO:
521 (u0, u1, u2) = map (ord, e[1][2])
522 us_per_4 = u2 + 256 * (u1 + 256 * u0)
523 seconds_per_1 = us_per_4 * 4 / 1e6
524 events.append ((t, Tempo (seconds_per_1)))
525 elif e[1][1] == midi.TIME_SIGNATURE:
526 (num, dur, clocks4, count32) = map (ord, e[1][2])
528 events.append ((t, Time (num, den)))
529 elif e[1][1] == midi.KEY_SIGNATURE:
530 (alterations, minor) = map (ord, e[1][2])
533 if alterations < 127:
536 flats = 256 - alterations
538 k = Key (sharps, flats, minor)
539 events.append ((t, k))
541 # ugh, must set key while parsing
542 # because Note init uses key
543 # Better do Note.calc () at dump time?
544 global_options.key = k
546 elif (e[1][1] == midi.LYRIC
547 or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT)):
549 last_lyric.clocks = t - last_time
550 events.append ((last_time, last_lyric))
552 last_lyric = Text (midi.LYRIC, e[1][2])
554 elif (e[1][1] >= midi.SEQUENCE_NUMBER
555 and e[1][1] <= midi.CUE_POINT):
556 events.append ((t, Text (e[1][1], e[1][2])))
558 if global_options.verbose:
559 sys.stderr.write ("SKIP: %s\n" % `e`)
562 if global_options.verbose:
563 sys.stderr.write ("SKIP: %s\n" % `e`)
567 # last_lyric.clocks = t - last_time
569 last_lyric.clocks = clocks_per_4
570 events.append ((last_time, last_lyric))
575 if i < len (events) and notes[0][0] >= events[i][0]:
578 events.insert (i, notes[0])
582 def unthread_notes (channel):
591 if (e[1].__class__ == Note
592 and ((t == start_busy_t
593 and e[1].clocks + t == end_busy_t)
594 or t >= end_busy_t)):
597 end_busy_t = t + e[1].clocks
598 elif (e[1].__class__ == Time
599 or e[1].__class__ == Key
600 or e[1].__class__ == Text
601 or e[1].__class__ == Tempo):
605 threads.append (thread)
620 def dump_skip (skip, clocks):
621 return skip + Duration (clocks).dump () + ' '
630 if i.__class__ == Note:
635 s = s + dump (notes[0])
636 elif len (notes) > 1:
637 global reference_note
639 s = s + notes[0].dump (dump_dur=False)
642 s = s + i.dump (dump_dur=False)
645 s = s + notes[0].duration.dump () + ' '
649 def dump_bar_line (last_bar_t, t, bar_count):
651 bar_t = time.bar_clocks ()
652 if t - last_bar_t >= bar_t:
653 bar_count = bar_count + (t - last_bar_t) / bar_t
655 if t - last_bar_t == bar_t:
656 s = '|\n %% %d\n ' % bar_count
659 # urg, this will barf at meter changes
660 last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
662 return (s, last_bar_t, bar_count)
665 def dump_voice (thread, skip):
666 global reference_note, time
668 global_options.key = Key (0, 0, 0)
670 # urg LilyPond doesn't start at c4, but
671 # remembers from previous tracks!
672 # reference_note = Note (clocks_per_4, 4*12, 0)
673 ref = Note (0, 4*12, 0)
674 if not reference_note:
677 ref.duration = reference_note.duration
684 if last_e and last_e[0] == e[0]:
688 chs.append ((last_e[0], ch))
695 chs.append ((last_e[0], ch))
705 i = lines[-1].rfind ('\n') + 1
706 if len (lines[-1][i:]) > LINE_BELL:
711 if bar_max and t > time.bar_clocks () * bar_max:
712 d = time.bar_clocks () * bar_max - last_t
713 lines[-1] = lines[-1] + dump_skip (skip, d)
715 errorport.write ('BUG: time skew')
717 (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
720 if bar_max and bar_count > bar_max:
723 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 '\n '.join (lines) + '\n'
739 def number2ascii (i):
744 s = '%c' % (m + ord ('A')) + s
748 def get_track_name (i):
749 return 'track' + number2ascii (i)
751 def get_channel_name (i):
752 return 'channel' + number2ascii (i)
754 def get_voice_name (i):
756 return 'voice' + number2ascii (i)
759 def get_voice_layout (average_pitch):
761 for i in range (len (average_pitch)):
762 d[average_pitch[i]] = i
763 s = list (reversed (sorted (average_pitch)))
764 non_empty = len (filter (lambda x: x, s))
765 names = ['One', 'Two']
767 names = ['One', 'Three', 'Four', 'Two']
768 layout = map (lambda x: '', range (len (average_pitch)))
769 for i, n in zip (s, names):
775 def dump_track (track, n):
777 track_name = get_track_name (n)
779 average_pitch = track_average_pitch (track)
780 voices = len (filter (lambda x: x, average_pitch[1:]))
781 clef = get_best_clef (average_pitch[0])
785 for channel in track:
786 channel_name = get_channel_name (c)
788 for voice in channel:
789 voice_name = get_voice_name (v)
790 voice_id = track_name + channel_name + voice_name
791 item = voice_first_item (voice)
793 if item and item.__class__ == Note:
795 s += '%(voice_id)s = ' % locals ()
796 if not global_options.absolute_pitches:
798 elif item and item.__class__ == Text:
800 s += '%(voice_id)s = \\lyricmode ' % locals ()
803 s += '%(voice_id)s = ' % locals ()
805 if average_pitch[v+1] and voices > 1:
806 s += ' \\voice' + get_voice_layout (average_pitch[1:])[v] + '\n'
807 s += ' ' + dump_voice (voice, skip)
811 s += '%(track_name)s = <<\n' % locals ()
814 s += clef.dump () + '\n'
818 for channel in track:
819 channel_name = get_channel_name (c)
821 for voice in channel:
822 voice_name = get_voice_name (v)
824 voice_id = track_name + channel_name + voice_name
825 item = voice_first_item (voice)
827 if item and item.__class__ == Text:
829 s += ' \\context %(context)s = %(voice_name)s \\%(voice_id)s\n' % locals ()
833 def voice_first_item (voice):
835 if (event[1].__class__ == Note
836 or (event[1].__class__ == Text
837 and event[1].type == midi.LYRIC)):
841 def channel_first_item (channel):
842 for voice in channel:
843 first = voice_first_item (voice)
848 def track_first_item (track):
849 for channel in track:
850 first = channel_first_item (channel)
855 def track_average_pitch (track):
859 for channel in track:
860 for voice in channel:
864 if event[1].__class__ == Note:
867 p[v] += event[1].pitch
876 def get_best_clef (average_pitch):
878 if average_pitch <= 3*12:
880 elif average_pitch <= 5*12:
882 elif average_pitch >= 7*12:
886 def convert_midi (in_file, out_file):
887 global clocks_per_1, clocks_per_4, key
888 global start_quant_clocks
889 global duration_quant_clocks
890 global allowed_tuplet_clocks
892 str = open (in_file, 'rb').read ()
893 clocks_max = bar_max * clocks_per_1 * 2
894 midi_dump = midi.parse (str, clocks_max)
896 clocks_per_1 = midi_dump[0][1]
897 clocks_per_4 = clocks_per_1 / 4
899 if global_options.start_quant:
900 start_quant_clocks = clocks_per_1 / global_options.start_quant
902 if global_options.duration_quant:
903 duration_quant_clocks = clocks_per_1 / global_options.duration_quant
905 allowed_tuplet_clocks = []
906 for (dur, num, den) in global_options.allowed_tuplets:
907 allowed_tuplet_clocks.append (clocks_per_1 / dur * num / den)
909 if global_options.verbose:
910 print 'allowed tuplet clocks:', allowed_tuplet_clocks
913 for t in midi_dump[1]:
914 global_options.key = Key (0, 0, 0)
915 tracks.append (split_track (t))
917 tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, in_file)
929 \remove "Note_heads_engraver"
930 \consists "Completion_heads_engraver"
935 for i in global_options.include_header:
936 s += '\n%% included from %(i)s\n' % locals ()
937 s += open (i).read ()
942 for i in range (len (tracks)):
943 s = s + dump_track (tracks[i], i)
945 s += '\n\\score {\n <<\n'
949 track_name = get_track_name (i)
950 item = track_first_item (t)
952 if item and item.__class__ == Note:
953 s += ' \\context Staff=%(track_name)s \\%(track_name)s\n' % locals ()
954 elif item and item.__class__ == Text:
955 s += ' \\context Lyrics=%(track_name)s \\%(track_name)s\n' % locals ()
960 progress (_ ("%s output to `%s'...") % ('LY', out_file))
965 handle = open (out_file, 'w')
971 def get_option_parser ():
972 p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'midi2ly',
973 description=_ ("Convert %s to LilyPond input.\n") % 'MIDI',
974 add_help_option=False)
976 p.add_option ('-a', '--absolute-pitches',
978 help=_ ('print absolute pitches'))
979 p.add_option ('-d', '--duration-quant',
981 help=_ ('quantise note durations on DUR'))
982 p.add_option ('-e', '--explicit-durations',
984 help=_ ('print explicit durations'))
985 p.add_option('-h', '--help',
987 help=_ ('show this help and exit'))
988 p.add_option('-i', '--include-header',
989 help=_ ('prepend FILE to output'),
993 p.add_option('-k', '--key', help=_ ('set key: ALT=+sharps|-flats; MINOR=1'),
994 metavar=_ ('ALT[:MINOR]'),
996 p.add_option ('-o', '--output', help=_ ('write output to FILE'),
999 p.add_option ('-p', '--preview', help=_ ('preview of first 4 bars'),
1000 action='store_true')
1001 p.add_option ('-s', '--start-quant',help= _ ('quantise note starts on DUR'),
1003 p.add_option ('-t', '--allow-tuplet',
1004 metavar=_ ('DUR*NUM/DEN'),
1006 dest='allowed_tuplets',
1007 help=_ ('allow tuplet durations DUR*NUM/DEN'),
1009 p.add_option ('-V', '--verbose', help=_ ('be verbose'),
1012 p.version = 'midi2ly (LilyPond) @TOPLEVEL_VERSION@'
1013 p.add_option ('--version',
1015 help=_ ('show version number and exit'))
1016 p.add_option ('-w', '--warranty', help=_ ('show warranty and copyright'),
1017 action='store_true',
1019 p.add_option ('-x', '--text-lyrics', help=_ ('treat every text as a lyric'),
1020 action='store_true')
1022 p.add_option_group (ly.display_encode (_ ('Examples')),
1024 $ midi2ly --key=-2:1 --duration-quant=32 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
1026 p.add_option_group ('',
1028 _ ('Report bugs via %s')
1029 % 'http://post.gmane.org/post.php'
1030 '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
1036 opt_parser = get_option_parser ()
1037 (options, args) = opt_parser.parse_args ()
1039 if not args or args[0] == '-':
1040 opt_parser.print_help ()
1041 ly.stderr_write ('\n%s: %s %s\n' % (program_name, _ ('error: '),
1042 _ ('no files specified on command line.')))
1045 if options.duration_quant:
1046 options.duration_quant = int (options.duration_quant)
1048 if options.warranty:
1052 (alterations, minor) = map (int, (options.key + ':0').split (':'))[0:2]
1055 if alterations >= 0:
1056 sharps = alterations
1058 flats = - alterations
1060 options.key = Key (sharps, flats, minor)
1062 if options.start_quant:
1063 options.start_quant = int (options.start_quant)
1069 options.allowed_tuplets = [map (int, a.replace ('/','*').split ('*'))
1070 for a in options.allowed_tuplets]
1073 sys.stderr.write ('Allowed tuplets: %s\n' % `options.allowed_tuplets`)
1075 global global_options
1076 global_options = options
1081 files = do_options ()
1085 g = strip_extension (g, '.midi')
1086 g = strip_extension (g, '.mid')
1087 g = strip_extension (g, '.MID')
1088 (outdir, outbase) = ('','')
1090 if not global_options.output:
1092 outbase = os.path.basename (g)
1093 o = os.path.join (outdir, outbase + '-midi.ly')
1094 elif global_options.output[-1] == os.sep:
1095 outdir = global_options.output
1096 outbase = os.path.basename (g)
1097 os.path.join (outdir, outbase + '-gen.ly')
1099 o = global_options.output
1100 (outdir, outbase) = os.path.split (o)
1102 if outdir != '.' and outdir != '':
1104 os.mkdir (outdir, 0777)
1110 if __name__ == '__main__':