lily/chord.cc

   1 /*
   2   chord.cc -- implement Chord
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1999--2000 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include "chord.hh"
  10 #include "musical-request.hh"
  11 #include "warn.hh"
  12 #include "debug.hh"
  13 #include "molecule.hh"
  14 #include "paper-def.hh"
  15 #include "lookup.hh"
  16
  17
  18 /*
  19   construct from parser output
  20 */
  21 Chord
  22 to_chord (Musical_pitch tonic, Array<Musical_pitch>* add_arr_p, Array<Musical_pitch>* sub_arr_p, Musical_pitch* inversion_p, Musical_pitch* bass_p)
  23 {
  24   // urg: catch dim modifier: 3rd, 5th, 7th, .. should be lowered
  25   bool dim_b = false;
  26   for (int i=0; i < add_arr_p->size (); i++)
  27     {
  28       Musical_pitch* p = &(*add_arr_p)[i];
  29       if (p->octave_i_ == -100)
  30         {
  31           p->octave_i_ = 0;
  32           dim_b = true;
  33         }
  34     }
  35   Chord::rebuild_transpose (add_arr_p, tonic, true);
  36   Chord::rebuild_transpose (sub_arr_p, tonic, true);
  37
  38   Musical_pitch fifth = Chord::base_arr (tonic).top ();
  39
  40   /*
  41     remove double adds (urg: sus4)
  42    */
  43   for (int i = add_arr_p->size () - 1; i >= 0 ; i--)
  44     {
  45       int j = Chord::find_pitch_i (add_arr_p, (*add_arr_p)[i]);
  46       if ((j != -1) && (i != j))
  47         {
  48             add_arr_p->get (i);
  49         }
  50     }
  51
  52   /*
  53     default chord includes upto 5: <1, 3, 5>
  54    */
  55   add_arr_p->insert (tonic, 0);
  56   Array<Musical_pitch> tmp = *add_arr_p;
  57   int highest_step = Chord::step_i (tonic, tmp.top ());
  58   if (highest_step < 5)
  59     tmp.push (fifth);
  60   else if (dim_b)
  61     {
  62       Musical_pitch* p = &add_arr_p->top ();
  63       p->accidental_i_--;
  64     }
  65
  66   /*
  67     find missing thirds
  68    */
  69   Array<Musical_pitch> missing_arr = Chord::missing_thirds_pitch_arr (&tmp);
  70   if (highest_step < 5)
  71     missing_arr.push (fifth);
  72
  73   /*
  74     if dim modifier is given: lower all missing
  75    */
  76   if (dim_b)
  77     {
  78       for (int i=0; i < missing_arr.size (); i++)
  79         {
  80           missing_arr[i].accidental_i_--;
  81         }
  82     }
  83
  84   /*
  85     if additions include some 3, don't add third
  86    */
  87   Musical_pitch third = Chord::base_arr (tonic)[1];
  88   if (Chord::find_notename_i (add_arr_p, third) != -1)
  89     {
  90       int i = Chord::find_pitch_i (&missing_arr, third);
  91       if (i != -1)
  92         missing_arr.get (i);
  93     }
  94
  95   /*
  96     if additions include 4, assume sus4 and don't add third implicitely
  97      C-sus (4) = c f g (1 4 5)
  98    */
  99   Musical_pitch sus = tonic;
 100   sus.transpose (Musical_pitch (3));
 101   if (Chord::find_pitch_i (add_arr_p, sus) != -1)
 102     {
 103       int i = Chord::find_pitch_i (&missing_arr, third);
 104       if (i != -1)
 105         missing_arr.get (i);
 106     }
 107
 108   /*
 109     if additions include some 5, don't add fifth
 110    */
 111   if (Chord::find_notename_i (add_arr_p, fifth) != -1)
 112     {
 113       int i = Chord::find_pitch_i (&missing_arr, fifth);
 114       if (i != -1)
 115         missing_arr.get (i);
 116     }
 117
 118
 119   /*
 120     complete the list of thirds to be added
 121    */
 122   add_arr_p->concat (missing_arr);
 123   add_arr_p->sort (Musical_pitch::compare);
 124
 125   Array<Musical_pitch> pitch_arr;
 126   /*
 127    add all that aren't subtracted
 128    */
 129   for (int i = 0; i < add_arr_p->size (); i++)
 130     {
 131       Musical_pitch p = (*add_arr_p)[i];
 132       int j = 0;
 133       for (; j < sub_arr_p->size (); j++)
 134         if (p == (*sub_arr_p)[j])
 135           {
 136             sub_arr_p->del (j);
 137             j = -1;
 138             break;
 139           }
 140       if (j == sub_arr_p->size ())
 141         pitch_arr.push (p);
 142     }
 143
 144   pitch_arr.sort (Musical_pitch::compare);
 145
 146   for (int i = 0; i < sub_arr_p->size (); i++)
 147     warning (_f ("invalid subtraction: not part of chord: %s",
 148                  (*sub_arr_p)[i].str ()));
 149
 150   return Chord (pitch_arr, inversion_p, bass_p);
 151 }
 152
 153 /*
 154   Construct from list of pitches and requests
 155  */
 156 Chord
 157 to_chord (Array<Musical_pitch> pitch_arr, Tonic_req* tonic_req, Inversion_req* inversion_req, Bass_req* bass_req, bool find_inversion_b)
 158 {
 159   Musical_pitch* inversion_p = 0;
 160   Musical_pitch* bass_p = 0;
 161
 162   if (bass_req)
 163     {
 164       assert (pitch_arr[0].notename_i_ == bass_req->pitch_.notename_i_);
 165       bass_p = new Musical_pitch (pitch_arr.get (0));
 166     }
 167
 168   if (inversion_req)
 169     {
 170       assert (pitch_arr[0].notename_i_ == inversion_req->pitch_.notename_i_);
 171       inversion_p = new Musical_pitch (inversion_req->pitch_);
 172       assert (tonic_req);
 173       int tonic_i = Chord::find_notename_i (&pitch_arr, tonic_req->pitch_);
 174       if (tonic_i)
 175         Chord::rebuild_insert_inversion (&pitch_arr, tonic_i);
 176     }
 177
 178   if (find_inversion_b && !inversion_p)
 179     {
 180       int tonic_i = tonic_req
 181         ? Chord::find_notename_i (&pitch_arr, tonic_req->pitch_)
 182         : Chord::find_tonic_i (&pitch_arr);
 183
 184       if (tonic_i)
 185         {
 186           inversion_p = &pitch_arr[0];
 187           Chord::rebuild_insert_inversion (&pitch_arr, tonic_i);
 188         }
 189     }
 190
 191   if (tonic_req)
 192     {
 193       assert (pitch_arr[0].notename_i_ == tonic_req->pitch_.notename_i_);
 194     }
 195
 196   return Chord (pitch_arr, inversion_p, bass_p);
 197 }
 198
 199 Chord::Chord ()
 200 {
 201   inversion_b_ = false;
 202   bass_b_ = false;
 203 }
 204
 205 Chord::Chord (Array<Musical_pitch> pitch_arr, Musical_pitch* inversion_p, Musical_pitch* bass_p)
 206 {
 207   pitch_arr_ = pitch_arr;
 208   inversion_b_ = false;
 209   bass_b_ = false;
 210   if (inversion_p)
 211     {
 212       inversion_pitch_ = *inversion_p;
 213       inversion_b_ = true;
 214       delete inversion_p;
 215     }
 216   if (bass_p)
 217     {
 218       bass_pitch_ = *bass_p;
 219       bass_b_ = true;
 220       delete bass_p;
 221     }
 222 }
 223
 224 Chord::Chord (Chord const& chord)
 225 {
 226   pitch_arr_ = chord.pitch_arr_;
 227   inversion_b_ = chord.inversion_b_;
 228   inversion_pitch_ = chord.inversion_pitch_;
 229   bass_b_ = chord.bass_b_;
 230   bass_pitch_ = chord.bass_pitch_;
 231 }
 232
 233
 234 /*
 235   JUNKME.
 236   do something smarter.
 237  */
 238 Array<Musical_pitch>
 239 Chord::base_arr (Musical_pitch p)
 240 {
 241   Array<Musical_pitch> base;
 242   base.push (p);
 243   p.transpose (Musical_pitch (2));
 244   base.push (p);
 245   p.transpose (Musical_pitch (2, -1));
 246   base.push (p);
 247   return base;
 248 }
 249
 250 void
 251 Chord::rebuild_transpose (Array<Musical_pitch>* pitch_arr_p, Musical_pitch tonic, bool fix7_b)
 252 {
 253   for (int i = 0; i < pitch_arr_p->size (); i++)
 254     {
 255       Musical_pitch p = tonic;
 256       Musical_pitch q = (*pitch_arr_p)[i];
 257       p.transpose (q);
 258       // duh, c7 should mean <c bes>
 259       if (fix7_b && (step_i (tonic, p) == 7))
 260         p.accidental_i_--;
 261       (*pitch_arr_p)[i] = p;
 262     }
 263   pitch_arr_p->sort (Musical_pitch::compare);
 264 }
 265
 266 int
 267 Chord::find_pitch_i (Array<Musical_pitch> const* pitch_arr_p, Musical_pitch p)
 268 {
 269   for (int i = 0; i < pitch_arr_p->size (); i++)
 270     if (p == (*pitch_arr_p)[i])
 271       return i;
 272   return -1;
 273 }
 274
 275 int
 276 Chord::find_notename_i (Array<Musical_pitch> const* pitch_arr_p, Musical_pitch p)
 277 {
 278   int i = find_pitch_i (pitch_arr_p, p);
 279   if (i == -1)
 280     {
 281       for (int i = 0; i < pitch_arr_p->size (); i++)
 282         {
 283           p.octave_i_ = (*pitch_arr_p)[i].octave_i_;
 284           if (p == (*pitch_arr_p)[i])
 285             return i;
 286         }
 287     }
 288   return i;
 289 }
 290
 291 int
 292 Chord::step_i (Musical_pitch tonic, Musical_pitch p)
 293 {
 294   int i = p.notename_i_ - tonic.notename_i_
 295     + (p.octave_i_ - tonic.octave_i_) * 7;
 296   while (i < 0)
 297     i += 7;
 298   i++;
 299   return i;
 300 }
 301
 302 /*
 303   JUNKME.
 304   do something smarter.
 305  */
 306 Array<Musical_pitch>
 307 Chord::missing_thirds_pitch_arr (Array<Musical_pitch> const* pitch_arr_p)
 308 {
 309   Array<Musical_pitch> thirds;
 310
 311   /* is the third c-e, d-f, etc. small or large? */
 312   int minormajor_a[] = {0, -1, -1, 0,0,-1,-1};
 313   for (int i=0; i < 7; i++)
 314     thirds.push (Musical_pitch( 2, minormajor_a[i]));
 315
 316   Musical_pitch tonic = (*pitch_arr_p)[0];
 317   Musical_pitch last = tonic;
 318   Array<Musical_pitch> missing_arr;
 319
 320   for (int i = 0; i < pitch_arr_p->size ();)
 321     {
 322       Musical_pitch p = (*pitch_arr_p)[i];
 323       int step = step_i (tonic, p);
 324       if (last.notename_i_ == p.notename_i_)
 325         last.transpose (thirds[(last.notename_i_ - tonic.notename_i_ + 7) % 7]);
 326       if (step > step_i (tonic, last))
 327         {
 328           while (step > step_i (tonic, last))
 329             {
 330               if ((last.notename_i_ - tonic.notename_i_ + 7) % 7 == 6)
 331                 {
 332                   Musical_pitch special_seven = last;
 333                   Musical_pitch lower (0, -1);
 334                   special_seven.transpose (lower);
 335                   missing_arr.push (special_seven);
 336                 }
 337               else
 338                 {
 339                   missing_arr.push (last);
 340                 }
 341               last.transpose (thirds[(last.notename_i_ - tonic.notename_i_ + 7) % 7]);
 342             }
 343         }
 344       else
 345         {
 346           i++;
 347         }
 348     }
 349   return missing_arr;
 350 }
 351
 352
 353 /*
 354  Mangle into list of pitches.
 355  For normal chord entry, inversion and bass pitches are retained in
 356  specific *_requests
 357  */
 358 Array<Musical_pitch>
 359 Chord::to_pitch_arr () const
 360 {
 361   Array<Musical_pitch> pitch_arr = pitch_arr_;
 362   if (inversion_b_)
 363     {
 364       int i = 0;
 365       for (; i < pitch_arr.size (); i++)
 366         {
 367           if ((pitch_arr[i].notename_i_ == inversion_pitch_.notename_i_)
 368               && (pitch_arr[i].accidental_i_ == inversion_pitch_.accidental_i_))
 369             break;
 370         }
 371       if (i == pitch_arr.size ())
 372         {
 373           warning (_f ("invalid inversion pitch: not part of chord: %s",
 374                        inversion_pitch_.str ()));
 375         }
 376       else
 377         rebuild_with_bass (&pitch_arr, i);
 378     }
 379
 380   if (bass_b_)
 381     {
 382       pitch_arr.insert (bass_pitch_, 0);
 383       rebuild_with_bass (&pitch_arr, 0);
 384     }
 385   return pitch_arr;
 386 }
 387
 388 /*
 389   This routine tries to guess tonic in a possibly inversed chord, ie
 390   <e g c'> should produce: C.
 391   This is only used for chords that are entered as simultaneous notes,
 392   chords entered in \chord mode are fully defined.
 393  */
 394 int
 395 Chord::find_tonic_i (Array<Musical_pitch> const* pitch_arr_p)
 396 {
 397   /*
 398     find tonic
 399
 400     first try: base of longest line of thirds
 401    */
 402   int tonic_i = 0;
 403   int longest_i = 0;
 404   for (int i = 0; i < pitch_arr_p->size (); i++)
 405     {
 406       int no_third_i = 0;
 407       int last_i = (*pitch_arr_p)[i % pitch_arr_p->size ()].notename_i_;
 408       int j = 0;
 409       for (; j < pitch_arr_p->size (); j++)
 410         {
 411           int cur_i = (*pitch_arr_p)[(i + j + 1) % pitch_arr_p->size ()].notename_i_;
 412           int gap = cur_i - last_i;
 413           while (gap < 0)
 414             gap += 7;
 415           gap %= 7;
 416           if (gap == 2)
 417             last_i = cur_i;
 418           else
 419             no_third_i++;
 420         }
 421       if (j - no_third_i > longest_i)
 422         {
 423           longest_i = j - no_third_i;
 424           tonic_i = i;
 425         }
 426     }
 427
 428   /*
 429     second try: note after biggest gap
 430    */
 431   int biggest_i = 0;
 432   //  if (longest_i)
 433   if (longest_i <= 1)
 434     for (int i = 0; i < pitch_arr_p->size (); i++)
 435       {
 436         int gap = (*pitch_arr_p)[i].notename_i_
 437           - (*pitch_arr_p)[(i - 1 + pitch_arr_p->size ())
 438           % pitch_arr_p->size ()].notename_i_;
 439         while (gap < 0)
 440           gap += 7;
 441         gap %= 7;
 442         if (gap > biggest_i)
 443           {
 444             biggest_i = gap;
 445             tonic_i = i;
 446           }
 447       }
 448   return tonic_i;
 449 }
 450
 451 void
 452 Chord::rebuild_from_base (Array<Musical_pitch>* pitch_arr_p, int base_i)
 453 {
 454   assert (base_i >= 0);
 455   Musical_pitch last (0, 0, -5);
 456   Array<Musical_pitch> new_arr;
 457   for (int i = 0; i < pitch_arr_p->size (); i++)
 458     {
 459       Musical_pitch p = (*pitch_arr_p)[(base_i + i) % pitch_arr_p->size ()];
 460       if (p < last)
 461         {
 462           p.octave_i_ = last.octave_i_;
 463           if (p < last)
 464             p.octave_i_++;
 465         }
 466       new_arr.push (p);
 467       last = p;
 468     }
 469   *pitch_arr_p = new_arr;
 470 }
 471
 472 void
 473 Chord::rebuild_insert_inversion (Array<Musical_pitch>* pitch_arr_p, int tonic_i)
 474 {
 475   assert (tonic_i > 0);
 476   Musical_pitch inversion = pitch_arr_p->get (0);
 477   rebuild_from_base (pitch_arr_p, tonic_i - 1);
 478   if (pitch_arr_p->size ())
 479     {
 480       inversion.octave_i_ = (*pitch_arr_p)[0].octave_i_ - 1;
 481       while (inversion < (*pitch_arr_p)[0])
 482         inversion.octave_i_++;
 483     }
 484   for (int i = 0; i < pitch_arr_p->size (); i++)
 485     if ((*pitch_arr_p)[i] > inversion)
 486       {
 487         pitch_arr_p->insert (inversion, i);
 488         break;
 489       }
 490 }
 491
 492 void
 493 Chord::rebuild_with_bass (Array<Musical_pitch>* pitch_arr_p, int bass_i)
 494 {
 495   assert (bass_i >= 0);
 496   Musical_pitch bass = pitch_arr_p->get (bass_i);
 497   // is lowering fine, or should others be raised?
 498   if (pitch_arr_p->size ())
 499     while (bass > (*pitch_arr_p)[0])
 500       bass.octave_i_--;
 501   pitch_arr_p->insert (bass, 0);
 502 }
 503