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