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--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include "midi-item.hh"
  10
  11 #include "duration.hh"
  12 #include "international.hh"
  13 #include "main.hh"
  14 #include "midi-stream.hh"
  15 #include "misc.hh"
  16 #include "program-option.hh"
  17 #include "string-convert.hh"
  18 #include "warn.hh"
  19
  20 #include "killing-cons.tcc"
  21
  22 #define PITCH_WHEEL_TOP 0x3FFF
  23 #define PITCH_WHEEL_CENTER 0x2000
  24 #define PITCH_WHEEL_BOTTOM 0x0000
  25 #define PITCH_WHEEL_RANGE (PITCH_WHEEL_TOP - PITCH_WHEEL_BOTTOM)
  26
  27 Midi_item *
  28 Midi_item::get_midi (Audio_item *a)
  29 {
  30   if (Audio_key *i = dynamic_cast<Audio_key *> (a))
  31     return new Midi_key (i);
  32   else if (Audio_instrument *i = dynamic_cast<Audio_instrument *> (a))
  33     return i->str_.length () ? new Midi_instrument (i) : 0;
  34   else if (Audio_note *i = dynamic_cast<Audio_note *> (a))
  35     return new Midi_note (i);
  36   else if (Audio_dynamic *i = dynamic_cast<Audio_dynamic *> (a))
  37     return new Midi_dynamic (i);
  38   else if (Audio_piano_pedal *i = dynamic_cast<Audio_piano_pedal *> (a))
  39     return new Midi_piano_pedal (i);
  40   else if (Audio_tempo *i = dynamic_cast<Audio_tempo *> (a))
  41     return new Midi_tempo (i);
  42   else if (Audio_time_signature *i = dynamic_cast<Audio_time_signature *> (a))
  43     return new Midi_time_signature (i);
  44   else if (Audio_text *i = dynamic_cast<Audio_text *> (a))
  45     //return i->text_string_.length () ? new Midi_text (i) : 0;
  46     return new Midi_text (i);
  47   else
  48     assert (0);
  49
  50   // isn't C++ grand?
  51   return 0;
  52 }
  53
  54 void
  55 Midi_chunk::set (string header_string, string data_string, string footer_string)
  56 {
  57   data_string_ = data_string;
  58   footer_string_ = footer_string;
  59   header_string_ = header_string;
  60 }
  61
  62 string
  63 Midi_chunk::data_string () const
  64 {
  65   return data_string_;
  66 }
  67
  68 string
  69 Midi_chunk::to_string () const
  70 {
  71   string str = header_string_;
  72   string dat = data_string ();
  73   string length_string = String_convert::int2hex (dat.length ()
  74                                                   + footer_string_.length (), 8, '0');
  75   length_string = String_convert::hex2bin (length_string);
  76
  77   str += length_string;
  78   str += dat;
  79   str += footer_string_;
  80
  81   return str;
  82 }
  83
  84 Midi_duration::Midi_duration (Real seconds_f)
  85 {
  86   seconds_ = seconds_f;
  87 }
  88
  89 string
  90 Midi_duration::to_string () const
  91 {
  92   return string ("<duration: ") + ::to_string (seconds_) + ">";
  93 }
  94
  95 Midi_event::Midi_event (Moment delta_mom, Midi_item *midi)
  96 {
  97   delta_mom_ = delta_mom;
  98   midi_ = midi;
  99 }
 100
 101 /*
 102   ugh. midi output badly broken since grace note hackage.
 103 */
 104 string
 105 Midi_event::to_string () const
 106 {
 107   Rational rat_dt = (delta_mom_.main_part_ * Rational (384)
 108                      + delta_mom_.grace_part_ * Rational (100)) * Rational (4);
 109   int delta_i = rat_dt.to_int ();
 110
 111   string delta_string = Midi_item::i2varint_string (delta_i);
 112   string midi_string = midi_->to_string ();
 113   assert (midi_string.length ());
 114   return delta_string + midi_string;
 115 }
 116
 117 Midi_header::Midi_header (int format_i, int tracks_i, int clocks_per_4_i)
 118 {
 119   string str;
 120
 121   string format_string = String_convert::int2hex (format_i, 4, '0');
 122   str += String_convert::hex2bin (format_string);
 123
 124   string tracks_string = String_convert::int2hex (tracks_i, 4, '0');
 125   str += String_convert::hex2bin (tracks_string);
 126
 127   string tempo_string = String_convert::int2hex (clocks_per_4_i, 4, '0');
 128   str += String_convert::hex2bin (tempo_string);
 129
 130   set ("MThd", str, "");
 131 }
 132
 133 Midi_instrument::Midi_instrument (Audio_instrument *a)
 134 {
 135   audio_ = a;
 136   audio_->str_ = String_convert::to_lower (audio_->str_);
 137 }
 138
 139 string
 140 Midi_instrument::to_string () const
 141 {
 142   Byte program_byte = 0;
 143   bool found = false;
 144
 145   /*
 146     UGH. don't use eval.
 147   */
 148   SCM proc = ly_lily_module_constant ("midi-program");
 149   SCM program = scm_call_1 (proc, ly_symbol2scm (audio_->str_.c_str ()));
 150   found = (program != SCM_BOOL_F);
 151   if (found)
 152     program_byte = scm_to_int (program);
 153   else
 154     warning (_f ("no such MIDI instrument: `%s'", audio_->str_.c_str ()));
 155
 156   string str = ::to_string ((char) (0xc0 + channel_)); //YIKES! FIXME : Should be track. -rz
 157   str += ::to_string ((char)program_byte);
 158   return str;
 159 }
 160
 161 Midi_item::Midi_item ()
 162 {
 163   channel_ = 0;
 164 }
 165
 166 Midi_item::~Midi_item ()
 167 {
 168 }
 169
 170 string
 171 Midi_item::i2varint_string (int i)
 172 {
 173   int buffer_i = i & 0x7f;
 174   while ((i >>= 7) > 0)
 175     {
 176       buffer_i <<= 8;
 177       buffer_i |= 0x80;
 178       buffer_i += (i & 0x7f);
 179     }
 180
 181   string str;
 182   while (1)
 183     {
 184       str += ::to_string ((char)buffer_i);
 185       if (buffer_i & 0x80)
 186         buffer_i >>= 8;
 187       else
 188         break;
 189     }
 190   return str;
 191 }
 192
 193 Midi_key::Midi_key (Audio_key *a)
 194 {
 195   audio_ = a;
 196 }
 197
 198 string
 199 Midi_key::to_string () const
 200 {
 201   string str = "ff5902";
 202   str += String_convert::int2hex (audio_->accidentals_, 2, '0');
 203   if (audio_->major_)
 204     str += String_convert::int2hex (0, 2, '0');
 205   else
 206     str += String_convert::int2hex (1, 2, '0');
 207   return String_convert::hex2bin (str);
 208 }
 209
 210 Midi_time_signature::Midi_time_signature (Audio_time_signature *a)
 211 {
 212   audio_ = a;
 213   clocks_per_1_ = 18;
 214 }
 215
 216 string
 217 Midi_time_signature::to_string () const
 218 {
 219   int num = abs (audio_->beats_);
 220   if (num > 255)
 221     {
 222       warning ("Time signature with more than 255 beats. Truncating");
 223       num = 255;
 224     }
 225
 226   int den = audio_->one_beat_;
 227
 228
 229
 230   string str = "ff5804";
 231   str += String_convert::int2hex (num, 2, '0');
 232   str += String_convert::int2hex (intlog2 (den), 2, '0');
 233   str += String_convert::int2hex (clocks_per_1_, 2, '0');
 234   str += String_convert::int2hex (8, 2, '0');
 235   return String_convert::hex2bin (str);
 236 }
 237
 238 Midi_note::Midi_note (Audio_note *a)
 239 {
 240   audio_ = a;
 241   dynamic_byte_ = 0x7f;
 242 }
 243
 244 Moment
 245 Midi_note::get_length () const
 246 {
 247   Moment m = audio_->length_mom_;
 248   return m;
 249 }
 250
 251 int
 252 Midi_note::get_fine_tuning () const
 253 {
 254   int ft = audio_->pitch_.quartertone_pitch ();
 255   ft -= 2 * audio_->pitch_.semitone_pitch ();
 256   ft *= 50; // 1 quarter tone = 50 cents
 257   return ft;
 258 }
 259
 260 int
 261 Midi_note::get_pitch () const
 262 {
 263   int p = audio_->pitch_.semitone_pitch () + audio_->transposing_;
 264   if (p == INT_MAX)
 265     {
 266       warning (_ ("silly pitch"));
 267       p = 0;
 268     }
 269   return p;
 270 }
 271
 272 string
 273 Midi_note::to_string () const
 274 {
 275   Byte status_byte = (char) (0x90 + channel_);
 276   string str = "";
 277   int finetune;
 278
 279   // print warning if fine tuning was needed, HJJ
 280   if (get_fine_tuning () != 0)
 281     {
 282       warning (_f ("experimental: temporarily fine tuning (of %d cents) a channel.",
 283                    get_fine_tuning ()));
 284
 285       finetune = PITCH_WHEEL_CENTER;
 286       // Move pitch wheel to a shifted position.
 287       // The pitch wheel range (of 4 semitones) is multiplied by the cents.
 288       finetune += (PITCH_WHEEL_RANGE *get_fine_tuning ()) / (4 * 100);
 289
 290       str += ::to_string ((char) (0xE0 + channel_));
 291       str += ::to_string ((char) (finetune & 0x7F));
 292       str += ::to_string ((char) (finetune >> 7));
 293       str += ::to_string ((char) (0x00));
 294     }
 295
 296   str += ::to_string ((char)status_byte);
 297   str += ::to_string ((char) (get_pitch () + c0_pitch_i_));
 298   str += ::to_string ((char)dynamic_byte_);
 299
 300   return str;
 301 }
 302
 303 Midi_note_off::Midi_note_off (Midi_note *n)
 304   : Midi_note (n->audio_)
 305 {
 306   on_ = n;
 307   channel_ = n->channel_;
 308
 309   // Anybody who hears any difference, or knows how this works?
 310   //  0 should definitely be avoided, notes stick on some sound cards.
 311   // 64 is supposed to be neutral
 312
 313   aftertouch_byte_ = 64;
 314 }
 315
 316 string
 317 Midi_note_off::to_string () const
 318 {
 319   Byte status_byte = (char) (0x80 + channel_);
 320
 321   string str = ::to_string ((char)status_byte);
 322   str += ::to_string ((char) (get_pitch () + Midi_note::c0_pitch_i_));
 323   str += ::to_string ((char)aftertouch_byte_);
 324
 325   if (get_fine_tuning () != 0)
 326     {
 327       // Move pitch wheel back to the central position.
 328       str += ::to_string ((char) 0x00);
 329       str += ::to_string ((char) (0xE0 + channel_));
 330       str += ::to_string ((char) (PITCH_WHEEL_CENTER &0x7F));
 331       str += ::to_string ((char) (PITCH_WHEEL_CENTER >> 7));
 332     }
 333
 334   return str;
 335 }
 336
 337 Midi_dynamic::Midi_dynamic (Audio_dynamic *a)
 338 {
 339   audio_ = a;
 340 }
 341
 342 string
 343 Midi_dynamic::to_string () const
 344 {
 345   Byte status_byte = (char) (0xB0 + channel_);
 346   string str = ::to_string ((char)status_byte);
 347
 348   /*
 349     Main volume controller (per channel):
 350     07 MSB
 351     27 LSB
 352   */
 353   static Real const full_scale = 127;
 354
 355   int volume = (int) (audio_->volume_ * full_scale);
 356   if (volume <= 0)
 357     volume = 1;
 358   if (volume > full_scale)
 359     volume = (int)full_scale;
 360
 361   str += ::to_string ((char)0x07);
 362   str += ::to_string ((char)volume);
 363   return str;
 364 }
 365
 366 Midi_piano_pedal::Midi_piano_pedal (Audio_piano_pedal *a)
 367 {
 368   audio_ = a;
 369 }
 370
 371 string
 372 Midi_piano_pedal::to_string () const
 373 {
 374   Byte status_byte = (char) (0xB0 + channel_);
 375   string str = ::to_string ((char)status_byte);
 376
 377   if (audio_->type_string_ == "Sostenuto")
 378     str += ::to_string ((char)0x42);
 379   else if (audio_->type_string_ == "Sustain")
 380     str += ::to_string ((char)0x40);
 381   else if (audio_->type_string_ == "UnaCorda")
 382     str += ::to_string ((char)0x43);
 383
 384   int pedal = ((1 - audio_->dir_) / 2) * 0x7f;
 385   str += ::to_string ((char)pedal);
 386   return str;
 387 }
 388
 389 Midi_tempo::Midi_tempo (Audio_tempo *a)
 390 {
 391   audio_ = a;
 392 }
 393
 394 string
 395 Midi_tempo::to_string () const
 396 {
 397   int useconds_per_4_i = 60 * (int)1e6 / audio_->per_minute_4_;
 398   string str = "ff5103";
 399   str += String_convert::int2hex (useconds_per_4_i, 6, '0');
 400   return String_convert::hex2bin (str);
 401 }
 402
 403 Midi_text::Midi_text (Audio_text *a)
 404 {
 405   audio_ = a;
 406 }
 407
 408 string
 409 Midi_text::to_string () const
 410 {
 411   string str = "ff" + String_convert::int2hex (audio_->type_, 2, '0');
 412   str = String_convert::hex2bin (str);
 413   str += i2varint_string (audio_->text_string_.length ());
 414   str += audio_->text_string_;
 415   return str;
 416 }
 417
 418 Midi_track::Midi_track ()
 419   : Midi_chunk ()
 420 {
 421   //                4D 54 72 6B     MTrk
 422   //                00 00 00 3B     chunk length (59)
 423   //        00      FF 58 04 04 02 18 08    time signature
 424   //        00      FF 51 03 07 A1 20       tempo
 425
 426   // FF 59 02 sf mi  Key Signature
 427   //         sf = -7:  7 flats
 428   //         sf = -1:  1 flat
 429   //         sf = 0:  key of C
 430   //         sf = 1:  1 sharp
 431   //         sf = 7: 7 sharps
 432   //         mi = 0:  major key
 433   //         mi = 1:  minor key
 434
 435   number_ = 0;
 436
 437   char const *data_str0 = ""
 438     //        "00" "ff58" "0404" "0218" "08"
 439     //  "00" "ff51" "0307" "a120"
 440     // why a key at all, in midi?
 441     // key: C
 442     //  "00" "ff59" "02" "00" "00"
 443     // key: F (scsii-menuetto)
 444     //                            "00" "ff59" "02" "ff" "00"
 445     ;
 446
 447   string data_string;
 448   // only for format 0 (currently using format 1)?
 449   data_string += String_convert::hex2bin (data_str0);
 450
 451   char const *footer_str0 = "00" "ff2f" "00";
 452   string footer_string = String_convert::hex2bin (footer_str0);
 453
 454   set ("MTrk", data_string, footer_string);
 455 }
 456
 457 void
 458 Midi_track::add (Moment delta_time_mom, Midi_item *midi)
 459 {
 460   assert (delta_time_mom >= Moment (0));
 461
 462   Midi_event *e = new Midi_event (delta_time_mom, midi);
 463   events_.push_back (e);
 464 }
 465
 466 string
 467 Midi_track::data_string () const
 468 {
 469   string str = Midi_chunk::data_string ();
 470   if (do_midi_debugging_global)
 471     str += "\n";
 472
 473   for (vector<Midi_event*>::const_iterator i (events_.begin());
 474        i != events_.end(); i ++)
 475     {
 476       str += (*i)->to_string ();
 477       if (do_midi_debugging_global)
 478         str += "\n";
 479     }
 480   return str;
 481 }
 482
 483
 484 char const *
 485 Midi_item::name () const
 486 {
 487    return this->class_name ();
 488 }
 489
 490 Midi_track::~Midi_track ()
 491 {
 492   junk_pointers (events_);
 493 }