lily/midi-item.cc

   1 /*
   2   midi-item.cc -- implement Midi items.
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--1998 Jan Nieuwenhuizen <janneke@gnu.org>
   7  */
   8
   9 #include "proto.hh"
  10 #include "plist.hh"
  11 #include "pcursor.hh"
  12 #include "debug.hh"
  13 #include "misc.hh"
  14 #include "string.hh"
  15 #include "string-convert.hh"
  16 #include "command-request.hh"
  17 #include "musical-request.hh"
  18 #include "midi-item.hh"
  19 #include "midi-stream.hh"
  20 #include "audio-item.hh"
  21
  22 IMPLEMENT_IS_TYPE_B (Midi_item);
  23 IMPLEMENT_IS_TYPE_B1 (Midi_chunk, Midi_item);
  24 IMPLEMENT_IS_TYPE_B1 (Midi_duration, Midi_item);
  25 IMPLEMENT_IS_TYPE_B1 (Midi_header, Midi_chunk);
  26 IMPLEMENT_IS_TYPE_B1 (Midi_instrument, Midi_item);
  27 IMPLEMENT_IS_TYPE_B1 (Midi_key,Midi_item);
  28 IMPLEMENT_IS_TYPE_B1 (Midi_time_signature, Midi_item);
  29 IMPLEMENT_IS_TYPE_B1 (Midi_note, Midi_item);
  30 IMPLEMENT_IS_TYPE_B1 (Midi_note_off, Midi_item);
  31 IMPLEMENT_IS_TYPE_B1 (Midi_tempo, Midi_item);
  32 IMPLEMENT_IS_TYPE_B1 (Midi_text, Midi_item);
  33 IMPLEMENT_IS_TYPE_B1 (Midi_track, Midi_chunk);
  34
  35 Midi_chunk::Midi_chunk ()
  36   : Midi_item (0)
  37 {
  38 }
  39
  40 void
  41 Midi_chunk::set (String header_str, String data_str, String footer_str)
  42 {
  43   data_str_ = data_str;
  44   footer_str_ = footer_str;
  45   header_str_ = header_str;
  46 }
  47
  48 String
  49 Midi_chunk::data_str () const
  50 {
  51   return data_str_;
  52 }
  53
  54 String
  55 Midi_chunk::str () const
  56 {
  57   String str = header_str_;
  58   String dat = data_str ();
  59 #if 1
  60   String length_str = String_convert::i2hex_str (dat.length_i ()
  61 #else
  62   // huh, huh??
  63   String length_str = String_convert::i2hex_str (data_str_.length_i ()
  64 #endif
  65     + footer_str_.length_i (), 8, '0');
  66   length_str = String_convert::hex2bin_str (length_str);
  67   str += length_str;
  68   str += dat;
  69   str += footer_str_;
  70   return str;
  71 }
  72
  73 Midi_duration::Midi_duration (Real seconds_f)
  74   : Midi_item (0)
  75 {
  76   seconds_f_ = seconds_f;
  77 }
  78
  79 String
  80 Midi_duration::str () const
  81 {
  82   return String ("<duration: ") + to_str (seconds_f_) + ">";
  83 }
  84
  85 Midi_event::Midi_event (Moment delta_mom, Midi_item* mitem_p)
  86 {
  87   delta_mom_ = delta_mom;
  88   mitem_p_ = mitem_p;
  89 }
  90
  91 Midi_event::~Midi_event ()
  92 {
  93 // uhuh
  94 //  delete mitem_p_;
  95 }
  96
  97 String
  98 Midi_event::str () const
  99 {
 100   int delta_i = delta_mom_ * Moment (Duration::division_1_i_s);
 101   String delta_str = Midi_item::i2varint_str (delta_i);
 102   String mitem_str = mitem_p_->str ();
 103   assert (mitem_str.length_i ());
 104   return delta_str + mitem_str;
 105 }
 106
 107
 108 Midi_header::Midi_header (int format_i, int tracks_i, int clocks_per_4_i)
 109   : Midi_chunk ()
 110 {
 111   String str;
 112
 113   String format_str = String_convert::i2hex_str (format_i, 4, '0');
 114   str += String_convert::hex2bin_str (format_str);
 115
 116   String tracks_str = String_convert::i2hex_str (tracks_i, 4, '0');
 117   str += String_convert::hex2bin_str (tracks_str);
 118
 119   String tempo_str = String_convert::i2hex_str (clocks_per_4_i, 4, '0');
 120   str += String_convert::hex2bin_str (tempo_str);
 121
 122   set ("MThd", str, "");
 123 }
 124
 125 char const* const instrument_name_sz_a_[ ] = {
 126
 127   /* default is usually piano */
 128   /* 0 "piano", */
 129
 130           /* (1-8 piano) */
 131           /* 1 */ "acoustic grand",
 132           /* 2 */ "bright acoustic",
 133           /* 3 */ "electric grand",
 134           /* 4 */ "honky-tonk",
 135           /* 5 */ "electric piano 1",
 136           /* 6 */ "electric piano 2",
 137           /* 7 */ "harpsichord",
 138           /* 8 */ "clav",
 139
 140           /* (9-16 chrom percussion) */
 141           /* 9 */ "celesta",
 142           /* 10 */ "glockenspiel",
 143           /* 11 */ "music box",
 144           /* 12 */ "vibraphone",
 145           /* 13 */ "marimba",
 146           /* 14 */ "xylophone",
 147           /* 15 */ "tubular bells",
 148           /* 16 */ "dulcimer",
 149
 150           /* (17-24 organ) */
 151           /* 17 */ "drawbar organ",
 152           /* 18 */ "percussive organ",
 153           /* 19 */ "rock organ",
 154           /* 20 */ "church organ",
 155           /* 21 */ "reed organ",
 156           /* 22 */ "accordion",
 157           /* 23 */ "harmonica",
 158           /* 24 */ "concertina",
 159
 160           /* (25-32 guitar) */
 161           /* 25 */ "acoustic guitar (nylon)",
 162           /* 26 */ "acoustic guitar (steel)",
 163           /* 27 */ "electric guitar (jazz)",
 164           /* 28 */ "electric guitar (clean)",
 165           /* 29 */ "electric guitar (muted)",
 166           /* 30 */ "overdriven guitar",
 167           /* 31 */ "distorted guitar",
 168           /* 32 */ "guitar harmonics",
 169
 170           /* (33-40 bass) */
 171           /* 33 */ "acoustic bass",
 172           /* 34 */ "electric bass (finger)",
 173           /* 35 */ "electric bass (pick)",
 174           /* 36 */ "fretless bass",
 175           /* 37 */ "slap bass 1",
 176           /* 38 */ "slap bass 2",
 177           /* 39 */ "synth bass 1",
 178           /* 40 */ "synth bass 2",
 179
 180           /* (41-48 strings) */
 181           /* 41 */ "violin",
 182           /* 42 */ "viola",
 183           /* 43 */ "cello",
 184           /* 44 */ "contrabass",
 185           /* 45 */ "tremolo strings",
 186           /* 46 */ "pizzicato strings",
 187           /* 47 */ "orchestral strings",
 188           /* 48 */ "timpani",
 189
 190           /* (49-56 ensemble) */
 191           /* 49 */ "string ensemble 1",
 192           /* 50 */ "string ensemble 2",
 193           /* 51 */ "synthstrings 1",
 194           /* 52 */ "synthstrings 2",
 195           /* 53 */ "choir aahs",
 196           /* 54 */ "voice oohs",
 197           /* 55 */ "synth voice",
 198           /* 56 */ "orchestra hit",
 199
 200           /* (57-64 brass) */
 201           /* 57 */ "trumpet",
 202           /* 58 */ "trombone",
 203           /* 59 */ "tuba",
 204           /* 60 */ "muted trumpet",
 205           /* 61 */ "french horn",
 206           /* 62 */ "brass section",
 207           /* 63 */ "synthbrass 1",
 208           /* 64 */ "synthbrass 2",
 209
 210           /* (65-72 reed) */
 211           /* 65 */ "soprano sax",
 212           /* 66 */ "alto sax",
 213           /* 67 */ "tenor sax",
 214           /* 68 */ "baritone sax",
 215           /* 69 */ "oboe",
 216           /* 70 */ "english horn",
 217           /* 71 */ "bassoon",
 218           /* 72 */ "clarinet",
 219
 220           /* (73-80 pipe) */
 221           /* 73 */ "piccolo",
 222           /* 74 */ "flute",
 223           /* 75 */ "recorder",
 224           /* 76 */ "pan flute",
 225           /* 77 */ "blown bottle",
 226           /* 78 */ "skakuhachi",
 227           /* 79 */ "whistle",
 228           /* 80 */ "ocarina",
 229
 230           /* (81-88 synth lead) */
 231           /* 81 */ "lead 1 (square)",
 232           /* 82 */ "lead 2 (sawtooth)",
 233           /* 83 */ "lead 3 (calliope)",
 234           /* 84 */ "lead 4 (chiff)",
 235           /* 85 */ "lead 5 (charang)",
 236           /* 86 */ "lead 6 (voice)",
 237           /* 87 */ "lead 7 (fifths)",
 238           /* 88 */ "lead 8 (bass+lead)",
 239
 240           /* (89-96 synth pad) */
 241           /* 89 */ "pad 1 (new age)",
 242           /* 90 */ "pad 2 (warm)",
 243           /* 91 */ "pad 3 (polysynth)",
 244           /* 92 */ "pad 4 (choir)",
 245           /* 93 */ "pad 5 (bowed)",
 246           /* 94 */ "pad 6 (metallic)",
 247           /* 95 */ "pad 7 (halo)",
 248           /* 96 */ "pad 8 (sweep)",
 249
 250           /* (97-104 synth effects) */
 251           /* 97 */ "fx 1 (rain)",
 252           /* 98 */ "fx 2 (soundtrack)",
 253           /* 99 */ "fx 3 (crystal)",
 254           /* 100 */ "fx 4 (atmosphere)",
 255           /* 101 */ "fx 5 (brightness)",
 256           /* 102 */ "fx 6 (goblins)",
 257           /* 103 */ "fx 7 (echoes)",
 258           /* 104 */ "fx 8 (sci-fi)",
 259
 260           /* (105-112 ethnic) */
 261           /* 105 */ "sitar",
 262           /* 106 */ "banjo",
 263           /* 107 */ "shamisen",
 264           /* 108 */ "koto",
 265           /* 109 */ "kalimba",
 266           /* 110 */ "bagpipe",
 267           /* 111 */ "fiddle",
 268           /* 112 */ "shanai",
 269
 270           /* (113-120 percussive) */
 271           /* 113 */ "tinkle bell",
 272           /* 114 */ "agogo",
 273           /* 115 */ "steel drums",
 274           /* 116 */ "woodblock",
 275           /* 117 */ "taiko drum",
 276           /* 118 */ "melodic tom",
 277           /* 119 */ "synth drum",
 278           /* 120 */ "reverse cymbal",
 279
 280           /* (121-128 sound effects) */
 281           /* 121 */ "guitar fret noise",
 282           /* 122 */ "breath noise",
 283           /* 123 */ "seashore",
 284           /* 124 */ "bird tweet",
 285           /* 125 */ "telephone ring",
 286           /* 126 */ "helicopter",
 287           /* 127 */ "applause",
 288           /* 128 */ "gunshot",
 289           0
 290 };
 291
 292 Midi_instrument::Midi_instrument (int channel_i, String instrument_str)
 293   : Midi_item (0)
 294 {
 295   instrument_str_ = instrument_str;
 296   instrument_str_.to_lower ();
 297   channel_i_ = channel_i;
 298 }
 299
 300 Midi_item::~Midi_item ()
 301 {
 302 }
 303
 304 String
 305 Midi_instrument::str () const
 306 {
 307   Byte program_byte = 0;
 308   for (int i = 0; instrument_name_sz_a_[i]; i++)
 309     if (instrument_str_ == String (instrument_name_sz_a_[ i ]))
 310       {
 311         program_byte = (Byte)i;
 312         break;
 313       }
 314
 315   String str = to_str ((char) (0xc0 + channel_i_));
 316   str += to_str ((char)program_byte);
 317   return str;
 318 }
 319
 320 Midi_item::Midi_item (Audio_item* audio_item_l)
 321 {
 322   audio_item_l_ = audio_item_l;
 323   channel_i_ = 0;
 324 }
 325
 326 String
 327 Midi_item::i2varint_str (int i)
 328 {
 329   int buffer_i = i & 0x7f;
 330   while ( (i >>= 7) > 0)
 331     {
 332       buffer_i <<= 8;
 333       buffer_i |= 0x80;
 334       buffer_i += (i & 0x7f);
 335     }
 336
 337   String str;
 338   while (1)
 339     {
 340       str += to_str ((char)buffer_i);
 341       if (buffer_i & 0x80)
 342         buffer_i >>= 8;
 343       else
 344         break;
 345     }
 346   return str;
 347 }
 348
 349 Midi_key::Midi_key (Audio_item* audio_item_l)
 350   : Midi_item (audio_item_l)
 351 {
 352 }
 353
 354 String
 355 Midi_key::str () const
 356 {
 357   Key_change_req* k = dynamic_cast <Key_change_req *> (audio_item_l_->req_l_);
 358   int sharps_i = k->sharps_i ();
 359   int flats_i = k->flats_i ();
 360
 361   // midi cannot handle non-conventional keys
 362   if (flats_i && sharps_i)
 363     {
 364       String str = _f ("unconventional key: flats: %d, sharps: %d", flats_i,
 365         sharps_i);
 366       flats_i = sharps_i = 0;
 367     }
 368   int accidentals_i = sharps_i - flats_i;
 369
 370   String str = "ff5902";
 371   str += String_convert::i2hex_str (accidentals_i, 2, '0');
 372   int minor_i = k->minor_b ();
 373   str += String_convert::i2hex_str (minor_i, 2, '0');
 374   return String_convert::hex2bin_str (str);
 375 }
 376
 377 Midi_time_signature::Midi_time_signature (Audio_item* audio_item_l)
 378   : Midi_item (audio_item_l)
 379 {
 380   clocks_per_1_i_ = 18;
 381 }
 382
 383 String
 384 Midi_time_signature::str () const
 385 {
 386   Time_signature_change_req* m = dynamic_cast <Time_signature_change_req *> (audio_item_l_->req_l_);
 387   int num_i = m->beats_i_;
 388   int den_i = m->one_beat_i_;
 389
 390   String str = "ff5804";
 391   str += String_convert::i2hex_str (num_i, 2, '0');
 392   str += String_convert::i2hex_str (intlog2 (den_i) , 2, '0');
 393   str += String_convert::i2hex_str (clocks_per_1_i_, 2, '0');
 394   str += String_convert::i2hex_str (8, 2, '0');
 395   return String_convert::hex2bin_str (str);
 396 }
 397
 398 Midi_note::Midi_note (Audio_item* audio_item_l)
 399   : Midi_item (audio_item_l)
 400 {
 401   dynamic_byte_ = 0x7f;
 402 }
 403
 404 Moment
 405 Midi_note::duration () const
 406 {
 407   Moment m = dynamic_cast <Rhythmic_req *> (audio_item_l_->req_l_)->duration ();
 408   if (m < Moment (1, 1000))
 409     {
 410       warning (_ ("silly duration"));
 411       m = 1;
 412      }
 413   return m;
 414 }
 415
 416 int
 417 Midi_note::pitch_i () const
 418 {
 419   int p = dynamic_cast <Melodic_req*> (audio_item_l_->req_l_)->pitch_.semitone_pitch ()
 420     + ((Audio_note*)audio_item_l_)->transposing_i_;
 421   if (p == INT_MAX)
 422     {
 423       warning (_ ("silly pitch"));
 424       p = 0;
 425      }
 426   return p;
 427 }
 428
 429 String
 430 Midi_note::str () const
 431 {
 432   Byte status_byte = (char) (0x90 + channel_i_);
 433
 434   String str = to_str ((char)status_byte);
 435   str += to_str ((char) (pitch_i () + c0_pitch_i_c_));
 436
 437   // poor man's staff dynamics:
 438   str += to_str ((char) (dynamic_byte_ - 0x10 * channel_i_));
 439
 440   return str;
 441 }
 442
 443 Midi_note_off::Midi_note_off (Midi_note* midi_note_l)
 444   : Midi_item (midi_note_l->audio_item_l_)
 445 {
 446   // 0x64 is supposed to be neutral, but let's try
 447   aftertouch_byte_ = 0x64;
 448   channel_i_ = midi_note_l->channel_i_;
 449 }
 450
 451 int
 452 Midi_note_off::pitch_i () const
 453 {
 454   return dynamic_cast <Melodic_req *> (audio_item_l_->req_l_)->pitch_.semitone_pitch ()
 455     + ((Audio_note*)audio_item_l_)->transposing_i_;
 456 }
 457
 458 String
 459 Midi_note_off::str () const
 460 {
 461   Byte status_byte = (char) (0x80 + channel_i_);
 462
 463   String str = to_str ((char)status_byte);
 464   str += to_str ((char) (pitch_i () + Midi_note::c0_pitch_i_c_));
 465   str += to_str ((char)aftertouch_byte_);
 466   return str;
 467 }
 468
 469 Midi_tempo::Midi_tempo (Audio_item* audio_item_l)
 470   : Midi_item (audio_item_l)
 471 {
 472   per_minute_4_i_ = ( (Audio_tempo*)audio_item_l_)->per_minute_4_i_;
 473 }
 474
 475 Midi_tempo::Midi_tempo (int per_minute_4_i)
 476   : Midi_item (0)
 477 {
 478   per_minute_4_i_ = per_minute_4_i;
 479 }
 480
 481 String
 482 Midi_tempo::str () const
 483 {
 484   int useconds_per_4_i = 60 * (int)1e6 / per_minute_4_i_;
 485   String str = "ff5103";
 486   str += String_convert::i2hex_str (useconds_per_4_i, 6, '0');
 487   return String_convert::hex2bin_str (str);
 488 }
 489
 490 Midi_text::Midi_text (Audio_item* audio_item_l)
 491   : Midi_item (audio_item_l)
 492 {
 493   text_str_ = ( (Audio_text*)audio_item_l_)->text_str_;
 494   type_ = (Type) ( (Audio_text*)audio_item_l_)->type_;
 495 }
 496
 497 Midi_text::Midi_text (Midi_text::Type type, String text_str)
 498   : Midi_item (0)
 499 {
 500   text_str_ = text_str;
 501   type_ = type;
 502 }
 503
 504 String
 505 Midi_text::str () const
 506 {
 507   String str = "ff" + String_convert::i2hex_str (type_, 2, '0');
 508   str = String_convert::hex2bin_str (str);
 509   str += i2varint_str (text_str_.length_i ());
 510   str += text_str_;
 511   return str;
 512 }
 513
 514 Midi_track::Midi_track ()
 515   : Midi_chunk ()
 516 {
 517   //                4D 54 72 6B     MTrk
 518   //                00 00 00 3B     chunk length (59)
 519   //        00      FF 58 04 04 02 18 08    time signature
 520   //        00      FF 51 03 07 A1 20       tempo
 521
 522 // FF 59 02 sf mi  Key Signature
 523 //         sf = -7:  7 flats
 524 //         sf = -1:  1 flat
 525 //         sf = 0:  key of C
 526 //         sf = 1:  1 sharp
 527 //         sf = 7: 7 sharps
 528 //         mi = 0:  major key
 529 //         mi = 1:  minor key
 530
 531   number_i_ = 0;
 532
 533   char const* data_ch_C = ""
 534     //        "00" "ff58" "0404" "0218" "08"
 535     //  "00" "ff51" "0307" "a120"
 536     // why a key at all, in midi?
 537     // key: C
 538     //  "00" "ff59" "02" "00" "00"
 539     // key: F (scsii-menuetto)
 540     //                            "00" "ff59" "02" "ff" "00"
 541         ;
 542
 543   String data_str;
 544   // only for format 0 (currently using format 1)?
 545   data_str += String_convert::hex2bin_str (data_ch_C);
 546
 547   char const* footer_ch_C = "00" "ff2f" "00";
 548   String footer_str = String_convert::hex2bin_str (footer_ch_C);
 549
 550   set ("MTrk", data_str, footer_str);
 551 }
 552
 553 void
 554 Midi_track::add (Moment delta_time_mom, Midi_item* mitem_p)
 555 {
 556   assert (delta_time_mom >= Moment (0));
 557
 558   event_p_list_.bottom ().add (new Midi_event (delta_time_mom, mitem_p));
 559 }
 560
 561 String
 562 Midi_track::data_str () const
 563 {
 564   String str = Midi_chunk::data_str ();
 565   if (check_debug && !monitor->silent_b ("Midistrings"))
 566     str += "\n";
 567   for (PCursor<Midi_event*> i (event_p_list_); i.ok (); i++)
 568     {
 569       str += i->str ();
 570       if (check_debug && !monitor->silent_b ("Midistrings"))
 571         str += "\n";
 572     }
 573   return str;
 574 }
 575
 576 Midi_track::~Midi_track ()
 577 {
 578 }