lily/accidental-engraver.cc

   1 /*
   2   accidental-engraver.cc -- implement accidental_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7   Modified 2001--2002 by Rune Zedeler <rz@daimi.au.dk>
   8 */
   9
  10 #include "accidental-placement.hh"
  11 #include "arpeggio.hh"
  12 #include "context.hh"
  13 #include "engraver.hh"
  14 #include "international.hh"
  15 #include "pitch.hh"
  16 #include "protected-scm.hh"
  17 #include "rhythmic-head.hh"
  18 #include "side-position-interface.hh"
  19 #include "stream-event.hh"
  20 #include "tie.hh"
  21 #include "warn.hh"
  22
  23 #include "translator.icc"
  24
  25 class Accidental_entry
  26 {
  27 public:
  28   bool done_;
  29   Stream_event *melodic_;
  30   Grob *accidental_;
  31   Context *origin_;
  32   Engraver *origin_engraver_;
  33   Grob *head_;
  34   bool tied_;
  35
  36   Accidental_entry ();
  37 };
  38
  39 Accidental_entry::Accidental_entry ()
  40 {
  41   tied_ = false;
  42   done_ = false;
  43   melodic_ = 0;
  44   accidental_ = 0;
  45   origin_ = 0;
  46   head_ = 0;
  47 }
  48
  49 class Accidental_engraver : public Engraver
  50 {
  51   int get_bar_number ();
  52   void update_local_key_signature ();
  53   void create_accidental (Accidental_entry *entry, bool, bool);
  54   Grob *make_standard_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
  55   Grob *make_suggested_accidental (Stream_event *note, Grob *note_head, Engraver *trans);
  56
  57 protected:
  58   TRANSLATOR_DECLARATIONS (Accidental_engraver);
  59   void process_music ();
  60
  61   void acknowledge_tie (Grob_info);
  62   void acknowledge_arpeggio (Grob_info);
  63   void acknowledge_rhythmic_head (Grob_info);
  64   void acknowledge_finger (Grob_info);
  65
  66   void stop_translation_timestep ();
  67   virtual void initialize ();
  68   void process_acknowledged ();
  69   virtual void finalize ();
  70   virtual void derived_mark () const;
  71
  72 public:
  73   SCM last_keysig_;     // ugh.
  74
  75   /*
  76     Urgh. Since the accidentals depend on lots of variables, we have
  77     to store all information before we can really create the
  78     accidentals.
  79   */
  80   vector<Grob*> left_objects_;
  81   vector<Grob*> right_objects_;
  82
  83   Grob *accidental_placement_;
  84
  85   vector<Accidental_entry> accidentals_;
  86   vector<Spanner*> ties_;
  87 };
  88
  89 /*
  90   TODO:
  91
  92   ugh, it is not clear what properties are mutable and which
  93   aren't. eg. localKeySignature is changed at runtime, which means
  94   that references in grobs should always store ly_deep_copy ()s of
  95   those.
  96 */
  97
  98
  99 Accidental_engraver::Accidental_engraver ()
 100 {
 101   accidental_placement_ = 0;
 102   last_keysig_ = SCM_EOL;
 103 }
 104
 105 void
 106 Accidental_engraver::derived_mark () const
 107 {
 108   scm_gc_mark (last_keysig_);
 109 }
 110
 111 void
 112 Accidental_engraver::update_local_key_signature ()
 113 {
 114   last_keysig_ = get_property ("keySignature");
 115   set_context_property_on_children (context (),
 116                                     ly_symbol2scm ("localKeySignature"),
 117                                     last_keysig_);
 118
 119   Context *trans = context ()->get_parent_context ();
 120
 121   /* Huh. Don't understand what this is good for. --hwn.  */
 122
 123   SCM val;
 124   while (trans && trans->where_defined (ly_symbol2scm ("localKeySignature"), &val))
 125     {
 126       trans->set_property ("localKeySignature", ly_deep_copy (last_keysig_));
 127       trans = trans->get_parent_context ();
 128     }
 129 }
 130
 131 void
 132 Accidental_engraver::initialize ()
 133 {
 134   update_local_key_signature ();
 135 }
 136
 137 /** Calculate the number of accidentals on basis of the current local key
 138     sig (passed as argument)
 139
 140     * First check step+octave (taking into account barnumbers if necessary).
 141
 142     * Then check the global signature (only step).
 143
 144     Return number of accidentals (0, 1 or 2).  */
 145
 146 static bool
 147 recent_enough (int bar_number, SCM alteration_def, SCM laziness)
 148 {
 149   if (scm_is_number (alteration_def)
 150       || laziness == SCM_BOOL_T)
 151     return true;
 152
 153   return (bar_number <= scm_to_int (scm_cdr (alteration_def)) + scm_to_int (laziness));
 154 }
 155
 156 static int
 157 extract_alteration (SCM alteration_def)
 158 {
 159   if (scm_is_number (alteration_def))
 160     return scm_to_int (alteration_def);
 161   else if (scm_is_pair (alteration_def))
 162     return scm_to_int (scm_car (alteration_def));
 163   else if (alteration_def == SCM_BOOL_F)
 164     return 0;
 165   else
 166     assert (0);
 167   return 0;
 168 }
 169
 170 bool
 171 is_tied (SCM alteration_def)
 172 {
 173   return (alteration_def == SCM_BOOL_T)
 174     || (scm_is_pair (alteration_def) && scm_car (alteration_def) == SCM_BOOL_T);
 175 }
 176
 177 static int
 178 number_accidentals_from_sig (bool *different, SCM sig, Pitch *pitch,
 179                              int bar_number, SCM laziness, bool ignore_octave)
 180 {
 181   int n = pitch->get_notename ();
 182   int o = pitch->get_octave ();
 183
 184   SCM previous_alteration = SCM_BOOL_F;
 185
 186   SCM from_same_octave = ly_assoc_get (scm_cons (scm_from_int (o),
 187                                                  scm_from_int (n)), sig, SCM_BOOL_F);
 188   SCM from_key_signature = ly_assoc_get (scm_from_int (n), sig, SCM_BOOL_F);
 189   SCM from_other_octaves = SCM_BOOL_F;
 190   for (SCM s = sig; scm_is_pair (s); s = scm_cdr (s))
 191     {
 192       SCM entry = scm_car (s);
 193       if (scm_is_pair (scm_car (entry))
 194           && scm_cdar (entry) == scm_from_int (n))
 195         from_other_octaves = scm_cdr (entry);
 196     }
 197
 198   if (from_same_octave != SCM_BOOL_F
 199       && recent_enough (bar_number, from_same_octave, laziness))
 200     previous_alteration = from_same_octave;
 201   else if (ignore_octave
 202            && from_other_octaves != SCM_BOOL_F
 203            && recent_enough (bar_number, from_other_octaves, laziness))
 204     previous_alteration = from_other_octaves;
 205   else if (from_key_signature != SCM_BOOL_F)
 206     previous_alteration = from_key_signature;
 207
 208   int num = 1;
 209   if (is_tied (previous_alteration))
 210     {
 211       num = 1;
 212       *different = true;
 213     }
 214   else
 215     {
 216       int prev = extract_alteration (previous_alteration);
 217       int alter = pitch->get_alteration ();
 218
 219       if (alter == prev)
 220         num = 0;
 221       else if ((abs (alter) < abs (prev)
 222                 || prev * alter < 0) && alter != 0)
 223         num = 2;
 224       *different = (alter != prev);
 225     }
 226   return num;
 227 }
 228
 229 static int
 230 number_accidentals (bool *different,
 231                     Pitch *pitch, Context *origin,
 232                     SCM accidentals, int bar_number)
 233 {
 234   int number = 0;
 235
 236   *different = false;
 237   if (scm_is_pair (accidentals) && !scm_is_symbol (scm_car (accidentals)))
 238     warning (_f ("accidental typesetting list must begin with context-name: %s",
 239                  ly_scm2string (scm_car (accidentals)).c_str ()));
 240
 241   for (; scm_is_pair (accidentals) && origin;
 242        accidentals = scm_cdr (accidentals))
 243     {
 244       // If pair then it is a new accidentals typesetting rule to be checked
 245       SCM rule = scm_car (accidentals);
 246       if (scm_is_pair (rule))
 247         {
 248           SCM type = scm_car (rule);
 249           SCM laziness = scm_cdr (rule);
 250           SCM localsig = origin->get_property ("localKeySignature");
 251
 252           bool same_octave_b
 253             = scm_is_eq (ly_symbol2scm ("same-octave"), type);
 254           bool any_octave_b
 255             = scm_is_eq (ly_symbol2scm ("any-octave"), type);
 256
 257           if (same_octave_b || any_octave_b)
 258             {
 259               bool d = false;
 260               int n = number_accidentals_from_sig
 261                 (&d, localsig, pitch, bar_number, laziness, any_octave_b);
 262               *different = *different || d;
 263               number = max (number, n);
 264             }
 265           else
 266             warning (_f ("ignoring unknown accidental: %s",
 267                          ly_symbol2string (type).c_str ()));
 268         }
 269
 270       /* if symbol then it is a context name.  Scan parent contexts to
 271          find it. */
 272       else if (scm_is_symbol (rule))
 273         {
 274           Context *dad = origin;
 275           while (dad && !dad->is_alias (rule))
 276             dad = dad->get_parent_context ();
 277
 278           if (dad)
 279             origin = dad;
 280         }
 281       else
 282         warning (_f ("pair or context-name expected for accidental rule, found %s",
 283                      ly_scm2string (rule).c_str ()));
 284     }
 285
 286   return number;
 287 }
 288
 289 int
 290 Accidental_engraver::get_bar_number ()
 291 {
 292   SCM barnum = get_property ("currentBarNumber");
 293   SCM smp = get_property ("measurePosition");
 294
 295   int bn = robust_scm2int (barnum, 0);
 296
 297   Moment mp = robust_scm2moment (smp, Moment (0));
 298   if (mp.main_part_ < Rational (0))
 299     bn--;
 300
 301   return bn;
 302 }
 303
 304 void
 305 Accidental_engraver::process_acknowledged ()
 306 {
 307   if (accidentals_.size () && !accidentals_.back ().done_)
 308     {
 309       SCM accidentals = get_property ("autoAccidentals");
 310       SCM cautionaries = get_property ("autoCautionaries");
 311       int barnum = get_bar_number ();
 312
 313       for (vsize i = 0; i < accidentals_.size (); i++)
 314         {
 315           if (accidentals_[i].done_)
 316             continue;
 317           accidentals_[i].done_ = true;
 318
 319           Stream_event *note = accidentals_[i].melodic_;
 320           Context *origin = accidentals_[i].origin_;
 321
 322           Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 323           if (!pitch)
 324             continue;
 325
 326           bool different = false;
 327           bool different_caut = false;
 328
 329           int num = number_accidentals (&different,
 330                                         pitch, origin,
 331                                         accidentals, barnum);
 332           int num_caut = number_accidentals (&different_caut,
 333                                              pitch, origin,
 334                                              cautionaries, barnum);
 335
 336           bool cautionary = to_boolean (note->get_property ("cautionary"));
 337
 338           if (num_caut > num)
 339             {
 340               num = num_caut;
 341               different = different_caut;
 342               cautionary = true;
 343             }
 344
 345           if (num == 0 && to_boolean (note->get_property ("force-accidental")))
 346             num = 1;
 347
 348           /* Cannot look for ties: it's not guaranteed that they reach
 349              us before the notes. */
 350           if (num
 351               && !note->in_event_class ("trill-span-event"))
 352             create_accidental (&accidentals_[i], num > 1, cautionary);
 353         }
 354     }
 355 }
 356
 357 void
 358 Accidental_engraver::create_accidental (Accidental_entry *entry,
 359                                         bool restore_natural,
 360                                         bool cautionary)
 361 {
 362   Stream_event *note = entry->melodic_;
 363   Grob *support = entry->head_;
 364   Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 365
 366   bool as_suggestion = to_boolean (entry->origin_->get_property ("suggestAccidentals"));
 367   Grob *a = 0;
 368   if (as_suggestion)
 369     a = make_suggested_accidental (note, support, entry->origin_engraver_);
 370   else
 371     a = make_standard_accidental (note, support, entry->origin_engraver_);
 372
 373   SCM accs = scm_cons (scm_from_int (pitch->get_alteration ()),
 374                        SCM_EOL);
 375   if (restore_natural)
 376     {
 377       if (to_boolean (get_property ("extraNatural")))
 378         accs = scm_cons (scm_from_int (0), accs);
 379     }
 380
 381   /* TODO: add cautionary option in accidental. */
 382   if (cautionary)
 383     a->set_property ("cautionary", SCM_BOOL_T);
 384
 385   a->set_property ("accidentals", accs);
 386   entry->accidental_ = a;
 387 }
 388
 389 Grob *
 390 Accidental_engraver::make_standard_accidental (Stream_event *note,
 391                                                Grob *note_head,
 392                                                Engraver *trans)
 393 {
 394
 395   (void)note;
 396   /*
 397     We construct the accidentals at the originating Voice
 398     level, so that we get the property settings for
 399     Accidental from the respective Voice.
 400   */
 401   Grob *a = trans->make_item ("Accidental", note_head->self_scm ());
 402
 403   /*
 404     We add the accidentals to the support of the arpeggio,
 405     so it is put left of the accidentals.
 406   */
 407   for (vsize i = 0; i < left_objects_.size (); i++)
 408     {
 409       if (left_objects_[i]->get_property ("side-axis") == scm_from_int (X_AXIS))
 410         Side_position_interface::add_support (left_objects_[i], a);
 411     }
 412
 413   /*
 414     Hmm. Junkme?
 415    */
 416   for (vsize i = 0; i < right_objects_.size (); i++)
 417     Side_position_interface::add_support (a, right_objects_[i]);
 418
 419   a->set_parent (note_head, Y_AXIS);
 420
 421   if (!accidental_placement_)
 422     accidental_placement_ = make_item ("AccidentalPlacement",
 423                                        a->self_scm ());
 424   Accidental_placement::add_accidental (accidental_placement_, a);
 425
 426   note_head->set_object ("accidental-grob", a->self_scm ());
 427
 428   return a;
 429 }
 430
 431 Grob *
 432 Accidental_engraver::make_suggested_accidental (Stream_event *note,
 433                                                 Grob *note_head,
 434                                                 Engraver *trans)
 435 {
 436   (void) note;
 437   Grob *a = trans->make_item ("AccidentalSuggestion", note_head->self_scm ());
 438
 439   Side_position_interface::add_support (a, note_head);
 440   if (Grob *stem = unsmob_grob (a->get_object ("stem")))
 441     Side_position_interface::add_support (a, stem);
 442
 443   a->set_parent (note_head, X_AXIS);
 444   return a;
 445 }
 446
 447 void
 448 Accidental_engraver::finalize ()
 449 {
 450   last_keysig_ = SCM_EOL;
 451 }
 452
 453 void
 454 Accidental_engraver::stop_translation_timestep ()
 455 {
 456   for (vsize j = ties_.size (); j--;)
 457     {
 458       Grob *r = Tie::head (ties_[j], RIGHT);
 459       for (vsize i = accidentals_.size (); i--;)
 460         if (accidentals_[i].head_ == r)
 461           {
 462             if (Grob *g = accidentals_[i].accidental_)
 463               {
 464                 g->set_object ("tie", ties_[j]->self_scm ());
 465                 accidentals_[i].tied_ = true;
 466               }
 467             ties_.erase (ties_.begin () + j);
 468             break;
 469           }
 470     }
 471
 472   for (vsize i = accidentals_.size (); i--;)
 473     {
 474       int barnum = get_bar_number ();
 475
 476       Stream_event *note = accidentals_[i].melodic_;
 477       Context *origin = accidentals_[i].origin_;
 478
 479       Pitch *pitch = unsmob_pitch (note->get_property ("pitch"));
 480       if (!pitch)
 481         continue;
 482
 483       int n = pitch->get_notename ();
 484       int o = pitch->get_octave ();
 485       int a = pitch->get_alteration ();
 486       SCM key = scm_cons (scm_from_int (o), scm_from_int (n));
 487
 488       SCM localsig = SCM_EOL;
 489       while (origin
 490              && origin->where_defined (ly_symbol2scm ("localKeySignature"), &localsig))
 491         {
 492           bool change = false;
 493           if (accidentals_[i].tied_)
 494             {
 495               /*
 496                 Remember an alteration that is different both from
 497                 that of the tied note and of the key signature.
 498               */
 499               localsig = ly_assoc_front_x
 500                 (localsig, key, scm_cons (SCM_BOOL_T, scm_from_int (barnum)));
 501
 502               change = true;
 503             }
 504           else
 505             {
 506               /*
 507                 not really really correct if there are more than one
 508                 noteheads with the same notename.
 509               */
 510               localsig = ly_assoc_front_x (localsig, key,
 511                                            scm_cons (scm_from_int (a),
 512                                                      scm_from_int (barnum)));
 513               change = true;
 514             }
 515
 516           if (change)
 517             origin->set_property ("localKeySignature", localsig);
 518
 519           origin = origin->get_parent_context ();
 520         }
 521     }
 522
 523   accidental_placement_ = 0;
 524   accidentals_.clear ();
 525   left_objects_.clear ();
 526   right_objects_.clear ();
 527 }
 528
 529 void
 530 Accidental_engraver::acknowledge_rhythmic_head (Grob_info info)
 531 {
 532   Stream_event *note = info.event_cause ();
 533   if (note
 534       && (note->in_event_class ("note-event")
 535           || note->in_event_class ("trill-span-event")))
 536     {
 537       /*
 538         string harmonics usually don't have accidentals.
 539       */
 540       if (to_boolean (get_property ("harmonicAccidentals"))
 541           || !ly_is_equal (info.grob ()->get_property ("style"),
 542                            ly_symbol2scm ("harmonic")))
 543         {
 544           Accidental_entry entry;
 545           entry.head_ = info.grob ();
 546           entry.origin_engraver_ = dynamic_cast<Engraver *> (info.origin_translator ());
 547           entry.origin_ = entry.origin_engraver_->context ();
 548           entry.melodic_ = note;
 549
 550           accidentals_.push_back (entry);
 551         }
 552     }
 553 }
 554
 555 void
 556 Accidental_engraver::acknowledge_tie (Grob_info info)
 557 {
 558   ties_.push_back (dynamic_cast<Spanner *> (info.grob ()));
 559 }
 560
 561 void
 562 Accidental_engraver::acknowledge_arpeggio (Grob_info info)
 563 {
 564   left_objects_.push_back (info.grob ());
 565 }
 566
 567 void
 568 Accidental_engraver::acknowledge_finger (Grob_info info)
 569 {
 570   left_objects_.push_back (info.grob ());
 571 }
 572
 573 void
 574 Accidental_engraver::process_music ()
 575 {
 576   SCM sig = get_property ("keySignature");
 577   /* Detect key sig changes.
 578      Update all parents and children.  */
 579   if (last_keysig_ != sig)
 580     update_local_key_signature ();
 581 }
 582
 583 ADD_ACKNOWLEDGER (Accidental_engraver, arpeggio);
 584 ADD_ACKNOWLEDGER (Accidental_engraver, finger);
 585 ADD_ACKNOWLEDGER (Accidental_engraver, rhythmic_head);
 586 ADD_ACKNOWLEDGER (Accidental_engraver, tie);
 587
 588 ADD_TRANSLATOR (Accidental_engraver,
 589
 590                 "Make accidentals.  "
 591                 "Catch note heads, ties and notices key-change events.  "
 592                 "This engraver usually lives at Staff level, but "
 593                 "reads the settings for Accidental at @code{Voice} level, "
 594                 "so you can @code{\\override} them at @code{Voice}. ",
 595                 "Accidental AccidentalSuggestion",
 596
 597                 "",
 598
 599                 "autoAccidentals "
 600                 "autoCautionaries "
 601                 "extraNatural "
 602                 "harmonicAccidentals "
 603                 "localKeySignature",
 604                 "localKeySignature");