]> git.donarmstrong.com Git - lilypond.git/blob - scripts/midi2ly.py
Merge branch 'master' into lilypond/translation
[lilypond.git] / scripts / midi2ly.py
1 #!@TARGET_PYTHON@
2 #
3 # midi2ly.py -- LilyPond midi import script
4
5 # This file is part of LilyPond, the GNU music typesetter.
6 #
7 # Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
8 #                           Jan Nieuwenhuizen <janneke@gnu.org>
9 #
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.
14 #
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.
19 #
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/>.
22
23
24 '''
25 TODO:
26     * test on weird and unquantised midi input (lily-devel)
27     * update doc and manpage
28
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
35 '''
36
37 import os
38 import sys
39
40 """
41 @relocate-preamble@
42 """
43
44 import midi
45 import lilylib as ly
46 global _;_=ly._
47
48 ################################################################
49 ## CONSTANTS
50
51
52 LINE_BELL = 60
53 scale_steps = [0, 2, 4, 5, 7, 9, 11]
54 global_options = None
55
56 clocks_per_1 = 1536
57 clocks_per_4 = 0
58
59 time = 0
60 reference_note = 0
61 start_quant_clocks = 0
62
63 duration_quant_clocks = 0
64 allowed_tuplet_clocks = []
65 bar_max = 0
66
67 ################################################################
68
69
70 program_name = sys.argv[0]
71 program_version = '@TOPLEVEL_VERSION@'
72
73 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
74            'Han-Wen Nienhuys <hanwen@xs4all.nl>')
75
76 errorport = sys.stderr
77
78 def identify ():
79     sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
80
81 def warranty ():
82     identify ()
83     ly.encoded_write (sys.stdout, '''
84 %s
85
86   %s
87
88 %s
89 %s
90 ''' % ( _ ('Copyright (c) %s by') % '1998--2011',
91         '\n  '.join (authors),
92         _ ('Distributed under terms of the GNU General Public License.'),
93         _ ('It comes with NO WARRANTY.')))
94
95 def progress (s):
96     ly.encoded_write (errorport, s + '\n')
97
98 def warning (s):
99     progress (_ ("warning: ") + s)
100
101 def error (s):
102     progress (_ ("error: ") + s)
103     raise Exception (_ ("Exiting... "))
104
105 def debug (s):
106     if 0:
107         progress ("debug: " + s)
108
109 def system (cmd, ignore_error = 0):
110     return ly.system (cmd, ignore_error=ignore_error)
111
112 def strip_extension (f, ext):
113     (p, e) = os.path.splitext (f)
114     if e == ext:
115         e = ''
116     return p + e
117
118
119 class Duration:
120     allowed_durs = (1, 2, 4, 8, 16, 32, 64, 128)
121     def __init__ (self, clocks):
122         self.clocks = clocks
123         if clocks <= 0:
124             self.clocks = duration_quant_clocks
125         (self.dur, self.num, self.den) = self.dur_num_den (clocks)
126
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]
131
132         dur = 0; num = 1; den = 1;
133         g = gcd (clocks, clocks_per_1)
134         if g:
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)
139
140     def dump (self):
141         if self.den == 1:
142             if self.num == 1:
143                 s = '%d' % self.dur
144             elif self.num == 3 and self.dur != 1:
145                 s = '%d.' % (self.dur / 2)
146             else:
147                 s = '%d*%d' % (self.dur, self.num)
148         else:
149             s = '%d*%d/%d' % (self.dur, self.num, self.den)
150
151         global reference_note
152         reference_note.duration = self
153
154         return s
155
156     def compare (self, other):
157         return self.clocks - other.clocks
158
159 def sign (x):
160     if x >= 0:
161         return 1
162     else:
163         return -1
164
165 class Note:
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):
170         self.pitch = pitch
171         self.velocity = velocity
172         # hmm
173         self.clocks = clocks
174         self.duration = Duration (clocks)
175         (self.octave, self.notename, self.alteration) = self.o_n_a ()
176
177     def o_n_a (self):
178         # major scale: do-do
179         # minor scale: la-la  (= + 5) '''
180
181         n = self.names[(self.pitch) % 12]
182         a = self.alterations[(self.pitch) % 12]
183
184         if a and global_options.key.flats:
185             a = - self.alterations[(self.pitch) % 12]
186             n = (n - a) % 7
187
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.)
196
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
206         #  have it.
207
208         #  John Sankey <bf250@freenet.carleton.ca>
209         #
210         #  Let's also do a-minor: a b c d e f gis a
211         #
212         #  --jcn
213
214         o = self.pitch / 12 - 4
215
216         key = global_options.key
217         if key.minor:
218             # as -> gis
219             if (key.sharps == 0 and key.flats == 0
220                 and n == 5 and a == -1):
221                 n = 4; a = 1
222             # des -> cis
223             elif key.flats == 1 and n == 1 and a == -1:
224                 n = 0; a = 1
225             # ges -> fis
226             elif key.flats == 2 and n == 4 and a == -1:
227                 n = 3; a = 1
228             # g -> fisis
229             elif key.sharps == 5 and n == 4 and a == 0:
230                 n = 3; a = 2
231             # d -> cisis
232             elif key.sharps == 6 and n == 1 and a == 0:
233                 n = 0; a = 2
234             # a -> gisis
235             elif key.sharps == 7 and n == 5 and a == 0:
236                 n = 4; a = 2
237
238         # b -> ces
239         if key.flats >= 6 and n == 6 and a == 0:
240             n = 0; a = -1; o = o + 1
241         # e -> fes
242         if key.flats >= 7 and n == 2 and a == 0:
243             n = 3; a = -1
244
245         # f -> eis
246         if key.sharps >= 3 and n == 3 and a == 0:
247             n = 2; a = 1
248         # c -> bis
249         if key.sharps >= 4 and n == 0 and a == 0:
250             n = 6; a = 1; o = o - 1
251
252         return (o, n, a)
253
254     def __repr__ (self):
255         s = chr ((self.notename + 2)  % 7 + ord ('a'))
256         return 'Note(%s %s)' % (s, self.duration.dump ())
257
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:
263             commas = self.octave
264         else:
265             delta = self.pitch - reference_note.pitch
266             commas = sign (delta) * (abs (delta) / 12)
267             if (((sign (delta)
268                   * (self.notename - reference_note.notename) + 7)
269                  % 7 >= 4)
270                 or ((self.notename == reference_note.notename)
271                     and (abs (delta) > 4) and (abs (delta) < 12))):
272                 commas = commas + sign (delta)
273
274         if commas > 0:
275             s = s + "'" * commas
276         elif commas < 0:
277             s = s + "," * -commas
278
279         if ((dump_dur
280              and self.duration.compare (reference_note.duration))
281             or global_options.explicit_durations):
282             s = s + self.duration.dump ()
283
284         reference_note = self
285
286         # TODO: move space
287         return s + ' '
288
289
290 class Time:
291     def __init__ (self, num, den):
292         self.clocks = 0
293         self.num = num
294         self.den = den
295
296     def bar_clocks (self):
297         return clocks_per_1 * self.num / self.den
298
299     def __repr__ (self):
300         return 'Time(%d/%d)' % (self.num, self.den)
301
302     def dump (self):
303         global time
304         time = self
305         return '\n  ' + '\\time %d/%d ' % (self.num, self.den) + '\n  '
306
307 class Tempo:
308     def __init__ (self, seconds_per_1):
309         self.clocks = 0
310         self.seconds_per_1 = seconds_per_1
311
312     def __repr__ (self):
313         return 'Tempo(%d)' % self.bpm ()
314
315     def bpm (self):
316         return 4 * 60 / self.seconds_per_1
317
318     def dump (self):
319         return '\n  ' + '\\tempo 4 = %d ' % (self.bpm ()) + '\n  '
320
321 class Clef:
322     clefs = ('"bass_8"', 'bass', 'violin', '"violin^8"')
323     def __init__ (self, type):
324         self.type = type
325
326     def __repr__ (self):
327         return 'Clef(%s)' % self.clefs[self.type]
328
329     def dump (self):
330         return '\n  \\clef %s\n  ' % self.clefs[self.type]
331
332 class Key:
333     key_sharps = ('c', 'g', 'd', 'a', 'e', 'b', 'fis')
334     key_flats = ('BUG', 'f', 'bes', 'es', 'as', 'des', 'ges')
335
336     def __init__ (self, sharps, flats, minor):
337         self.clocks = 0
338         self.flats = flats
339         self.sharps = sharps
340         self.minor = minor
341
342     def dump (self):
343         global_options.key = self
344
345         s = ''
346         if self.sharps and self.flats:
347             pass
348         else:
349             if self.flats:
350                 k = (ord ('cfbeadg'[self.flats % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
351             else:
352                 k = (ord ('cgdaebf'[self.sharps % 7]) - ord ('a') - 2 -2 * self.minor + 7) % 7
353
354             if not self.minor:
355                 name = chr ((k + 2) % 7 + ord ('a'))
356             else:
357                 name = chr ((k + 2) % 7 + ord ('a'))
358
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)
363             a = 0
364             if self.flats:
365                 if flats[k] <= self.flats:
366                     a = -1
367             else:
368                 if sharps[k] <= self.sharps:
369                     a = 1
370
371             if a:
372                 name = name + Note.alteration_names[a + 2]
373
374             s = '\\key ' + name
375             if self.minor:
376                 s = s + ' \\minor'
377             else:
378                 s = s + ' \\major'
379
380         return '\n\n  ' + s + '\n  '
381
382
383 class Text:
384     text_types = (
385         'SEQUENCE_NUMBER',
386         'TEXT_EVENT',
387         'COPYRIGHT_NOTICE',
388         'SEQUENCE_TRACK_NAME',
389         'INSTRUMENT_NAME',
390         'LYRIC',
391         'MARKER',
392         'CUE_POINT',)
393
394     def __init__ (self, type, text):
395         self.clocks = 0
396         self.type = type
397         self.text = text
398
399     def dump (self):
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 ()
407             s = s + ' '
408         else:
409             s = '\n  % [' + self.text_types[self.type] + '] ' + self.text + '\n  '
410         return s
411
412     def __repr__ (self):
413         return 'Text(%d=%s)' % (self.type, self.text)
414
415
416
417 def split_track (track):
418     chs = {}
419     for i in range (16):
420         chs[i] = []
421
422     for e in track:
423         data = list (e[1])
424         if data[0] > 0x7f and data[0] < 0xf0:
425             c = data[0] & 0x0f
426             e = (e[0], tuple ([data[0] & 0xf0] + data[1:]))
427             chs[c].append (e)
428         else:
429             chs[0].append (e)
430
431     for i in range (16):
432         if chs[i] == []:
433             del chs[i]
434
435     threads = []
436     for v in chs.values ():
437         events = events_on_channel (v)
438         t = unthread_notes (events)
439         if len (t):
440             threads.append (t)
441     return threads
442
443 def quantise_clocks (clocks, quant):
444     q = int (clocks / quant) * quant
445     if q != clocks:
446         for tquant in allowed_tuplet_clocks:
447             if int (clocks / tquant) * tquant == clocks:
448                 return clocks
449         if 2 * (clocks - q) > quant:
450             q = q + quant
451     return q
452
453 def end_note (pitches, notes, t, e):
454     try:
455         (lt, vel) = pitches[e]
456         del pitches[e]
457
458         i = len (notes) - 1
459         while i > 0:
460             if notes[i][0] > lt:
461                 i = i -1
462             else:
463                 break
464         d = t - lt
465         if duration_quant_clocks:
466             d = quantise_clocks (d, duration_quant_clocks)
467             if not d:
468                 d = duration_quant_clocks
469
470         notes.insert (i + 1,
471               (lt, Note (d, e, vel)))
472
473     except KeyError:
474         pass
475
476 def events_on_channel (channel):
477     pitches = {}
478
479     notes = []
480     events = []
481     last_lyric = 0
482     last_time = 0
483     for e in channel:
484         t = e[0]
485
486         if start_quant_clocks:
487             t = quantise_clocks (t, start_quant_clocks)
488
489
490         if (e[1][0] == midi.NOTE_OFF
491             or (e[1][0] == midi.NOTE_ON and e[1][2] == 0)):
492             debug ('%d: NOTE OFF: %s' % (t, e[1][1]))
493             if not e[1][2]:
494                 debug ('   ...treated as OFF')
495             end_note (pitches, notes, t, e[1][1])
496
497         elif e[1][0] == midi.NOTE_ON:
498             if not pitches.has_key (e[1][1]):
499                 debug ('%d: NOTE ON: %s' % (t, e[1][1]))
500                 pitches[e[1][1]] = (t, e[1][2])
501             else:
502                 debug ('...ignored')
503
504         # all include ALL_NOTES_OFF
505         elif (e[1][0] >= midi.ALL_SOUND_OFF
506           and e[1][0] <= midi.POLY_MODE_ON):
507             for i in pitches:
508                 end_note (pitches, notes, t, i)
509
510         elif e[1][0] == midi.META_EVENT:
511             if e[1][1] == midi.END_OF_TRACK:
512                 for i in pitches:
513                     end_note (pitches, notes, t, i)
514                 break
515
516             elif e[1][1] == midi.SET_TEMPO:
517                 (u0, u1, u2) = map (ord, e[1][2])
518                 us_per_4 = u2 + 256 * (u1 + 256 * u0)
519                 seconds_per_1 = us_per_4 * 4 / 1e6
520                 events.append ((t, Tempo (seconds_per_1)))
521             elif e[1][1] == midi.TIME_SIGNATURE:
522                 (num, dur, clocks4, count32) = map (ord, e[1][2])
523                 den = 2 ** dur
524                 events.append ((t, Time (num, den)))
525             elif e[1][1] == midi.KEY_SIGNATURE:
526                 (alterations, minor) = map (ord, e[1][2])
527                 sharps = 0
528                 flats = 0
529                 if alterations < 127:
530                     sharps = alterations
531                 else:
532                     flats = 256 - alterations
533
534                 k = Key (sharps, flats, minor)
535                 events.append ((t, k))
536
537                 # ugh, must set key while parsing
538                 # because Note init uses key
539                 # Better do Note.calc () at dump time?
540                 global_options.key = k
541
542             elif (e[1][1] == midi.LYRIC
543                   or (global_options.text_lyrics and e[1][1] == midi.TEXT_EVENT)):
544                 if last_lyric:
545                     last_lyric.clocks = t - last_time
546                     events.append ((last_time, last_lyric))
547                 last_time = t
548                 last_lyric = Text (midi.LYRIC, e[1][2])
549
550             elif (e[1][1] >= midi.SEQUENCE_NUMBER
551                   and e[1][1] <= midi.CUE_POINT):
552                 events.append ((t, Text (e[1][1], e[1][2])))
553             else:
554                 if global_options.verbose:
555                     sys.stderr.write ("SKIP: %s\n" % `e`)
556                 pass
557         else:
558             if global_options.verbose:
559                 sys.stderr.write ("SKIP: %s\n" % `e`)
560             pass
561
562     if last_lyric:
563         # last_lyric.clocks = t - last_time
564         # hmm
565         last_lyric.clocks = clocks_per_4
566         events.append ((last_time, last_lyric))
567         last_lyric = 0
568
569     i = 0
570     while len (notes):
571         if i < len (events) and notes[0][0] >= events[i][0]:
572             i = i + 1
573         else:
574             events.insert (i, notes[0])
575             del notes[0]
576     return events
577
578 def unthread_notes (channel):
579     threads = []
580     while channel:
581         thread = []
582         end_busy_t = 0
583         start_busy_t = 0
584         todo = []
585         for e in channel:
586             t = e[0]
587             if (e[1].__class__ == Note
588                 and ((t == start_busy_t
589                       and e[1].clocks + t == end_busy_t)
590                      or t >= end_busy_t)):
591                 thread.append (e)
592                 start_busy_t = t
593                 end_busy_t = t + e[1].clocks
594             elif (e[1].__class__ == Time
595                   or e[1].__class__ == Key
596                   or e[1].__class__ == Text
597                   or e[1].__class__ == Tempo):
598                 thread.append (e)
599             else:
600                 todo.append (e)
601         threads.append (thread)
602         channel = todo
603
604     return threads
605
606 def gcd (a,b):
607     if b == 0:
608         return a
609     c = a
610     while c:
611         c = a % b
612         a = b
613         b = c
614     return a
615
616 def dump_skip (skip, clocks):
617     return skip + Duration (clocks).dump () + ' '
618
619 def dump (d):
620     return d.dump ()
621
622 def dump_chord (ch):
623     s = ''
624     notes = []
625     for i in ch:
626         if i.__class__ == Note:
627             notes.append (i)
628         else:
629             s = s + i.dump ()
630     if len (notes) == 1:
631         s = s + dump (notes[0])
632     elif len (notes) > 1:
633         global reference_note
634         s = s + '<'
635         s = s + notes[0].dump (dump_dur=False)
636         r = reference_note
637         for i in notes[1:]:
638             s = s + i.dump (dump_dur=False)
639         s = s + '>'
640
641         s = s + notes[0].duration.dump () + ' '
642         reference_note = r
643     return s
644
645 def dump_bar_line (last_bar_t, t, bar_count):
646     s = ''
647     bar_t = time.bar_clocks ()
648     if t - last_bar_t >= bar_t:
649         bar_count = bar_count + (t - last_bar_t) / bar_t
650
651         if t - last_bar_t == bar_t:
652             s = '|\n  %% %d\n  ' % bar_count
653             last_bar_t = t
654         else:
655             # urg, this will barf at meter changes
656             last_bar_t = last_bar_t + (t - last_bar_t) / bar_t * bar_t
657
658     return (s, last_bar_t, bar_count)
659
660
661 def dump_voice (thread, skip):
662     global reference_note, time
663
664     global_options.key = Key (0, 0, 0)
665     time = Time (4, 4)
666     # urg LilyPond doesn't start at c4, but
667     # remembers from previous tracks!
668     # reference_note = Note (clocks_per_4, 4*12, 0)
669     ref = Note (0, 4*12, 0)
670     if not reference_note:
671         reference_note = ref
672     else:
673         ref.duration = reference_note.duration
674         reference_note = ref
675     last_e = None
676     chs = []
677     ch = []
678
679     for e in thread:
680         if last_e and last_e[0] == e[0]:
681             ch.append (e[1])
682         else:
683             if ch:
684                 chs.append ((last_e[0], ch))
685
686             ch = [e[1]]
687
688         last_e = e
689
690     if ch:
691         chs.append ((last_e[0], ch))
692     t = 0
693     last_t = 0
694     last_bar_t = 0
695     bar_count = 1
696
697     lines = ['']
698     for ch in chs:
699         t = ch[0]
700
701         i = lines[-1].rfind ('\n') + 1
702         if len (lines[-1][i:]) > LINE_BELL:
703             lines.append ('')
704
705         if t - last_t > 0:
706             d = t - last_t
707             if bar_max and t > time.bar_clocks () * bar_max:
708                 d = time.bar_clocks () * bar_max - last_t
709             lines[-1] = lines[-1] + dump_skip (skip, d)
710         elif t - last_t < 0:
711             errorport.write ('BUG: time skew')
712
713         (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
714                               t, bar_count)
715
716         if bar_max and bar_count > bar_max:
717             break
718
719         lines[-1] = lines[-1] + s
720         lines[-1] = lines[-1] + dump_chord (ch[1])
721
722         clocks = 0
723         for i in ch[1]:
724             if i.clocks > clocks:
725                 clocks = i.clocks
726
727         last_t = t + clocks
728
729         (s, last_bar_t, bar_count) = dump_bar_line (last_bar_t,
730                                                     last_t, bar_count)
731         lines[-1] = lines[-1] + s
732
733     return '\n  '.join (lines) + '\n'
734
735 def number2ascii (i):
736     s = ''
737     i += 1
738     while i > 0:
739         m = (i - 1) % 26
740         s = '%c' % (m + ord ('A')) + s
741         i = (i - m)/26
742     return s
743
744 def get_track_name (i):
745     return 'track' + number2ascii (i)
746
747 def get_channel_name (i):
748     return 'channel' + number2ascii (i)
749
750 def get_voice_name (i):
751     if True: #i:
752         return 'voice' + number2ascii (i)
753     return ''
754
755 def get_voice_layout (average_pitch):
756     d = {}
757     for i in range (len (average_pitch)):
758         d[average_pitch[i]] = i
759     s = list (reversed (sorted (average_pitch)))
760     non_empty = len (filter (lambda x: x, s))
761     names = ['One', 'Two']
762     if non_empty > 2:
763         names = ['One', 'Three', 'Four', 'Two']
764     layout = map (lambda x: '', range (len (average_pitch)))
765     for i, n in zip (s, names):
766         if i:
767             v = d[i]
768             layout[v] = n
769     return layout
770
771 def dump_track (track, n):
772     s = '\n'
773     track_name = get_track_name (n)
774
775     average_pitch = track_average_pitch (track)
776     voices = len (filter (lambda x: x, average_pitch[1:]))
777     clef = get_best_clef (average_pitch[0])
778
779     c = 0
780     v = 0
781     for channel in track:
782         channel_name = get_channel_name (c)
783         c += 1
784         for voice in channel:
785             voice_name = get_voice_name (v)
786             voice_id = track_name + channel_name + voice_name
787             item = voice_first_item (voice)
788
789             if item and item.__class__ == Note:
790                 skip = 's'
791                 s += '%(voice_id)s = ' % locals ()
792                 if not global_options.absolute_pitches:
793                     s += '\\relative c '
794             elif item and item.__class__ == Text:
795                 skip = '" "'
796                 s += '%(voice_id)s = \\lyricmode ' % locals ()
797             else:
798                 skip = '\\skip '
799                 s += '%(voice_id)s = ' % locals ()
800             s += '{\n'
801             if average_pitch[v+1] and voices > 1:
802                 s += '  \\voice' + get_voice_layout (average_pitch[1:])[v] + '\n'
803             s += '  ' + dump_voice (voice, skip)
804             s += '}\n\n'
805             v += 1
806
807     s += '%(track_name)s = <<\n' % locals ()
808
809     if clef.type != 2:
810         s += clef.dump () + '\n'
811
812     c = 0
813     v = 0
814     for channel in track:
815         channel_name = get_channel_name (c)
816         c += 1
817         for voice in channel:
818             voice_name = get_voice_name (v)
819             v += 1
820             voice_id = track_name + channel_name + voice_name
821             item = voice_first_item (voice)
822             context = 'Voice'
823             if item and item.__class__ == Text:
824                 context = 'Lyrics'
825             s += '  \\context %(context)s = %(voice_name)s \\%(voice_id)s\n' % locals ()
826     s += '>>\n\n'
827     return s
828
829 def voice_first_item (voice):
830     for event in voice:
831         if (event[1].__class__ == Note
832             or (event[1].__class__ == Text
833                 and event[1].type == midi.LYRIC)):
834             return event[1]
835     return None
836
837 def channel_first_item (channel):
838     for voice in channel:
839         first = voice_first_item (voice)
840         if first:
841             return first
842     return None
843
844 def track_first_item (track):
845     for channel in track:
846         first = channel_first_item (channel)
847         if first:
848             return first
849     return None
850
851 def track_average_pitch (track):
852     i = 0
853     p = [0]
854     v = 1
855     for channel in track:
856         for voice in channel:
857             c = 0
858             p.append (0)
859             for event in voice:
860                 if event[1].__class__ == Note:
861                     i += 1
862                     c += 1
863                     p[v] += event[1].pitch
864             if c:
865                 p[0] += p[v]
866                 p[v] = p[v] / c
867             v += 1
868     if i:
869         p[0] = p[0] / i
870     return p
871
872 def get_best_clef (average_pitch):
873     if average_pitch:
874         if average_pitch <= 3*12:
875             return Clef (0)
876         elif average_pitch <= 5*12:
877             return Clef (1)
878         elif average_pitch >= 7*12:
879             return Clef (3)
880     return Clef (2)
881
882 def convert_midi (in_file, out_file):
883     global clocks_per_1, clocks_per_4, key
884     global start_quant_clocks
885     global duration_quant_clocks
886     global allowed_tuplet_clocks
887
888     str = open (in_file, 'rb').read ()
889     clocks_max = bar_max * clocks_per_1 * 2
890     midi_dump = midi.parse (str, clocks_max)
891
892     clocks_per_1 = midi_dump[0][1]
893     clocks_per_4 = clocks_per_1 / 4
894
895     if global_options.start_quant:
896         start_quant_clocks = clocks_per_1 / global_options.start_quant
897
898     if global_options.duration_quant:
899         duration_quant_clocks = clocks_per_1 / global_options.duration_quant
900
901     allowed_tuplet_clocks = []
902     for (dur, num, den) in global_options.allowed_tuplets:
903         allowed_tuplet_clocks.append (clocks_per_1 / dur * num / den)
904
905     if global_options.verbose:
906         print 'allowed tuplet clocks:', allowed_tuplet_clocks
907
908     tracks = []
909     for t in midi_dump[1]:
910         global_options.key = Key (0, 0, 0)
911         tracks.append (split_track (t))
912
913     tag = '%% Lily was here -- automatically converted by %s from %s' % ( program_name, in_file)
914
915
916     s = ''
917     s = tag + '\n\\version "2.7.38"\n\n'
918     for i in range (len (tracks)):
919         s = s + dump_track (tracks[i], i)
920
921     s += r'''
922 \layout {
923   \context {
924     \Voice
925     \remove "Note_heads_engraver"
926     \consists "Completion_heads_engraver"
927   }
928 }
929 '''
930
931     s += '\n\\score {\n  <<\n'
932
933     i = 0
934     for t in tracks:
935         track_name = get_track_name (i)
936         item = track_first_item (t)
937
938         if item and item.__class__ == Note:
939             s += '    \\context Staff=%(track_name)s \\%(track_name)s\n' % locals ()
940         elif item and item.__class__ == Text:
941             s += '    \\context Lyrics=%(track_name)s \\%(track_name)s\n' % locals ()
942
943         i += 1
944     s = s + '  >>\n}\n'
945
946     progress (_ ("%s output to `%s'...") % ('LY', out_file))
947
948     if out_file == '-':
949         handle = sys.stdout
950     else:
951         handle = open (out_file, 'w')
952
953     handle.write (s)
954     handle.close ()
955
956
957 def get_option_parser ():
958     p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'midi2ly',
959                  description=_ ("Convert %s to LilyPond input.\n") % 'MIDI',
960                  add_help_option=False)
961
962     p.add_option ('-a', '--absolute-pitches',
963            action='store_true',
964            help=_ ('print absolute pitches'))
965     p.add_option ('-d', '--duration-quant',
966            metavar=_ ('DUR'),
967            help=_ ('quantise note durations on DUR'))
968     p.add_option ('-e', '--explicit-durations',
969            action='store_true',
970            help=_ ('print explicit durations'))
971     p.add_option('-h', '--help',
972                  action='help',
973                  help=_ ('show this help and exit'))
974     p.add_option('-k', '--key', help=_ ('set key: ALT=+sharps|-flats; MINOR=1'),
975           metavar=_ ('ALT[:MINOR]'),
976           default='0'),
977     p.add_option ('-o', '--output', help=_ ('write output to FILE'),
978            metavar=_ ('FILE'),
979            action='store')
980     p.add_option ('-p', '--preview', help=_ ('preview of first 4 bars'),
981            action='store_true')
982     p.add_option ('-s', '--start-quant',help= _ ('quantise note starts on DUR'),
983            metavar=_ ('DUR'))
984     p.add_option ('-t', '--allow-tuplet',
985            metavar=_ ('DUR*NUM/DEN'),
986            action = 'append',
987            dest='allowed_tuplets',
988            help=_ ('allow tuplet durations DUR*NUM/DEN'),
989            default=[])
990     p.add_option ('-V', '--verbose', help=_ ('be verbose'),
991            action='store_true'
992            ),
993     p.version = 'midi2ly (LilyPond) @TOPLEVEL_VERSION@'
994     p.add_option ('--version',
995                  action='version',
996                  help=_ ('show version number and exit'))
997     p.add_option ('-w', '--warranty', help=_ ('show warranty and copyright'),
998            action='store_true',
999            ),
1000     p.add_option ('-x', '--text-lyrics', help=_ ('treat every text as a lyric'),
1001            action='store_true')
1002
1003     p.add_option_group (ly.display_encode (_ ('Examples')),
1004               description = r'''
1005   $ midi2ly --key=-2:1 --duration-quant=32 --allow-tuplet=4*2/3 --allow-tuplet=2*4/3 foo.midi
1006 ''')
1007     p.add_option_group ('',
1008                         description=(
1009             _ ('Report bugs via %s')
1010             % 'http://post.gmane.org/post.php'
1011             '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
1012     return p
1013
1014
1015
1016 def do_options ():
1017     opt_parser = get_option_parser ()
1018     (options, args) = opt_parser.parse_args ()
1019
1020     if not args or args[0] == '-':
1021         opt_parser.print_help ()
1022         ly.stderr_write ('\n%s: %s %s\n' % (program_name, _ ('error: '),
1023                          _ ('no files specified on command line.')))
1024         sys.exit (2)
1025
1026     if options.duration_quant:
1027         options.duration_quant = int (options.duration_quant)
1028
1029     if options.warranty:
1030         warranty ()
1031         sys.exit (0)
1032     if 1:
1033         (alterations, minor) = map (int, (options.key + ':0').split (':'))[0:2]
1034         sharps = 0
1035         flats = 0
1036         if alterations >= 0:
1037             sharps = alterations
1038         else:
1039             flats = - alterations
1040
1041         options.key = Key (sharps, flats, minor)
1042
1043     if options.start_quant:
1044         options.start_quant = int (options.start_quant)
1045
1046     global bar_max
1047     if options.preview:
1048         bar_max = 4
1049
1050     options.allowed_tuplets = [map (int, a.replace ('/','*').split ('*'))
1051                 for a in options.allowed_tuplets]
1052
1053     if options.verbose:
1054         sys.stderr.write ('Allowed tuplets: %s\n' % `options.allowed_tuplets`)
1055
1056     global global_options
1057     global_options = options
1058
1059     return args
1060
1061 def main ():
1062     files = do_options ()
1063
1064     for f in files:
1065         g = f
1066         g = strip_extension (g, '.midi')
1067         g = strip_extension (g, '.mid')
1068         g = strip_extension (g, '.MID')
1069         (outdir, outbase) = ('','')
1070
1071         if not global_options.output:
1072             outdir = '.'
1073             outbase = os.path.basename (g)
1074             o = os.path.join (outdir, outbase + '-midi.ly')
1075         elif global_options.output[-1] == os.sep:
1076             outdir = global_options.output
1077             outbase = os.path.basename (g)
1078             os.path.join (outdir, outbase + '-gen.ly')
1079         else:
1080             o = global_options.output
1081             (outdir, outbase) = os.path.split (o)
1082
1083         if outdir != '.' and outdir != '':
1084             try:
1085                 os.mkdir (outdir, 0777)
1086             except OSError:
1087                 pass
1088
1089         convert_midi (f, o)
1090
1091 if __name__ == '__main__':
1092     main ()