lily/note-collision.cc

   1 /*
   2   collision.cc -- implement Collision
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "warn.hh"
  10 #include "note-collision.hh"
  11 #include "note-column.hh"
  12 #include "note-head.hh"
  13 #include "rhythmic-head.hh"
  14 #include "paper-def.hh"
  15 #include "axis-group-interface.hh"
  16 #include "item.hh"
  17 #include "stem.hh"
  18 #include "side-position-interface.hh"
  19 #include "dot-column.hh"
  20
  21 MAKE_SCHEME_CALLBACK (Note_collision_interface,force_shift_callback,2);
  22
  23 SCM
  24 Note_collision_interface::force_shift_callback (SCM element_smob, SCM axis)
  25 {
  26   Grob *me = unsmob_grob (element_smob);
  27   Axis a = (Axis) gh_scm2int (axis);
  28   assert (a == X_AXIS);
  29
  30    me = me->get_parent (a);
  31
  32    if (! to_boolean (me->get_grob_property ("positioning-done")))
  33     {
  34       me->set_grob_property ("positioning-done", SCM_BOOL_T);
  35       do_shifts (me);
  36     }
  37
  38   return gh_double2scm (0.0);
  39 }
  40
  41
  42 void
  43 check_meshing_chords (Grob *me,
  44                       Drul_array< Array < Real > > *offsets,
  45                       Drul_array< Array < Slice > > const &extents,
  46                       Drul_array<Link_array<Grob> > const &clash_groups)
  47
  48 {
  49   if (!extents[UP].size () || ! extents[DOWN].size ())
  50     return;
  51
  52   Grob *cu = clash_groups[UP][0];
  53   Grob *cd = clash_groups[DOWN][0];
  54
  55   /* Every note column should have a stem, but avoid a crash. */
  56   if (!Note_column::get_stem (cu) || !Note_column::get_stem (cd))
  57     return;
  58
  59   Grob *nu = Note_column::first_head (cu);
  60   Grob *nd = Note_column::first_head (cd);
  61
  62   Array<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
  63   Array<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
  64
  65   /* Too far apart to collide.  */
  66   if (ups[0] > dps.top () + 1)
  67     return;
  68
  69   // FIXME: what's this?
  70   bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
  71
  72   int upball_type = Note_head::get_balltype (nu);
  73   int dnball_type = Note_head::get_balltype (nd);
  74
  75   /* Do not merge whole notes (or longer, like breve, longa, maxima).  */
  76   if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
  77     merge_possible = false;
  78
  79   if (merge_possible
  80       && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
  81       && !to_boolean (me->get_grob_property ("merge-differently-dotted")))
  82     merge_possible = false;
  83
  84   /* Can only merge different heads if merge-differently-headed is
  85      set. */
  86   if (merge_possible
  87       && upball_type != dnball_type
  88       && !to_boolean (me->get_grob_property ("merge-differently-headed")))
  89     merge_possible = false;
  90
  91   /* Should never merge quarter and half notes, as this would make
  92      them indistinguishable.  */
  93   if (merge_possible
  94       && ((Rhythmic_head::duration_log (nu) == 1
  95            && Rhythmic_head::duration_log (nd) == 2)
  96           || (Rhythmic_head::duration_log (nu) == 2
  97              && Rhythmic_head::duration_log (nd) == 1)))
  98     merge_possible = false;
  99
 100
 101   /*
 102     this case (distant half collide),
 103
 104         |
 105       x |
 106      | x
 107      |
 108
 109    the noteheads may be closer than this case (close half collide)
 110
 111        |
 112        |
 113       x
 114      x
 115     |
 116     |
 117
 118    */
 119
 120   /* TODO: filter out the 'o's in this configuration, since they're no
 121   part in the collision.
 122
 123      |
 124     x|o
 125     x|o
 126     x
 127
 128    */
 129
 130   bool close_half_collide = false;
 131   bool distant_half_collide = false;
 132   bool full_collide = false;
 133
 134   int i = 0, j=0;
 135   while (i < ups.size () && j < dps.size ())
 136   {
 137     if (abs (ups[i] - dps[j]) == 1)
 138       {
 139         merge_possible = false;
 140         if (ups[i] > dps[j])
 141           close_half_collide = true;
 142         else
 143           distant_half_collide = true;
 144       }
 145     else if (ups[i]==dps[j])
 146       full_collide = true;
 147     else if (ups[i] >dps[0] && ups[i] < dps.top ())
 148       merge_possible = false;
 149     else if (dps[j] >ups[0] && dps[j] < ups.top ())
 150       merge_possible = false;
 151
 152     if (ups[i] < dps[j])
 153       i++;
 154     else if (ups[i] > dps[j])
 155       j++;
 156     else
 157       {
 158         i++;
 159         j++;
 160       }
 161   }
 162
 163   Drul_array<Real> center_note_shifts;
 164   center_note_shifts[LEFT] = 0.0;
 165   center_note_shifts[RIGHT] = 0.0;
 166
 167
 168   Real shift_amount = 1;
 169
 170   bool touch = (ups[0] - dps.top () >= 0);
 171   if (touch)
 172     shift_amount *= -1;
 173
 174   /* For full collisions, the right hand head may obscure dots, so
 175      make sure the dotted heads go to the right.  */
 176   if (Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd)
 177       && full_collide)
 178     shift_amount = 1;
 179
 180   if (merge_possible)
 181     {
 182       shift_amount = 0;
 183
 184       /* Wipe shortest head, or head with smallest amount of dots.
 185          Note: when merging different heads, dots on shortest
 186          disappear. */
 187
 188       Grob *wipe_ball = nu;
 189
 190       if (upball_type == dnball_type)
 191         {
 192           if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
 193             wipe_ball = nd;
 194         }
 195       else if (dnball_type > upball_type)
 196         wipe_ball = nd;
 197
 198       if (wipe_ball->live ())
 199         {
 200           wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
 201           wipe_ball->set_grob_property ("molecule", SCM_EOL);
 202
 203           if (Grob *d = unsmob_grob (wipe_ball->get_grob_property ("dot")))
 204             d->suicide ();
 205         }
 206     }
 207   /* TODO: these numbers are magic; should devise a set of grob props
 208      to tune this behavior.  */
 209   else if (close_half_collide && !touch)
 210     shift_amount *= 0.52;
 211   else if (distant_half_collide && !touch)
 212     shift_amount *= 0.4;
 213   else if (distant_half_collide || close_half_collide || full_collide)
 214     shift_amount *= 0.5;
 215
 216   /* we're meshing.  */
 217   else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
 218     shift_amount *= 0.1;
 219   else
 220     shift_amount *= 0.25;
 221
 222   /* For full or close half collisions, the right hand head may
 223      obscure dots.  Move dots to the right.  */
 224   if (abs (shift_amount) > 1e-6
 225       && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
 226       && (full_collide || close_half_collide))
 227     {
 228       Grob *d = unsmob_grob (nd->get_grob_property ("dot"));
 229       Grob *parent = d->get_parent (X_AXIS);
 230       if (Dot_column::has_interface (parent))
 231         Side_position_interface::add_support (parent, nu);
 232     }
 233
 234   Direction d = UP;
 235   do
 236     {
 237       for (int i=0; i < clash_groups[d].size (); i++)
 238         (*offsets)[d][i] += d * shift_amount;
 239     }
 240   while ((flip (&d))!= UP);
 241 }
 242
 243 void
 244 Note_collision_interface::do_shifts (Grob* me)
 245 {
 246   Drul_array< Link_array <Grob>  > cg = get_clash_groups (me);
 247
 248   SCM autos (automatic_shift (me, cg));
 249   SCM hand (forced_shift (me));
 250
 251
 252
 253   Direction d = UP;
 254   Real wid = 0.0;
 255   do
 256     {
 257       if(cg[d].size())
 258         {
 259           Grob  *h = cg[d][0];
 260           wid = Note_column::first_head(h)->extent(h,X_AXIS).length() ;
 261         }
 262     }
 263
 264   while (flip (&d) != UP);
 265
 266
 267   Link_array<Grob> done;
 268   for (; gh_pair_p (hand); hand =ly_cdr (hand))
 269     {
 270       Grob * s = unsmob_grob (ly_caar (hand));
 271       Real amount = gh_scm2double (ly_cdar (hand));
 272
 273       s->translate_axis (amount *wid, X_AXIS);
 274       done.push (s);
 275     }
 276   for (; gh_pair_p (autos); autos =ly_cdr (autos))
 277     {
 278       Grob * s = unsmob_grob (ly_caar (autos));
 279       Real amount = gh_scm2double (ly_cdar (autos));
 280
 281       if (!done.find (s))
 282         s->translate_axis (amount * wid, X_AXIS);
 283     }
 284 }
 285
 286 Drul_array< Link_array <Grob>  >
 287 Note_collision_interface::get_clash_groups (Grob *me)
 288 {
 289   Drul_array<Link_array<Grob> > clash_groups;
 290
 291   SCM s = me->get_grob_property ("elements");
 292   for (; gh_pair_p (s); s = ly_cdr (s))
 293     {
 294       SCM car = ly_car (s);
 295
 296       Grob * se = unsmob_grob (car);
 297       if (Note_column::has_interface (se))
 298         clash_groups[Note_column::dir (se)].push (se);
 299     }
 300
 301   Direction d = UP;
 302   do
 303     {
 304       Link_array<Grob> & clashes (clash_groups[d]);
 305       clashes.sort (Note_column::shift_compare);
 306     }
 307   while ((flip (&d))!= UP);
 308
 309   return clash_groups;
 310 }
 311
 312 /** This complicated routine moves note columns around horizontally to
 313   ensure that notes don't clash.
 314
 315   This should be put into Scheme.
 316   */
 317 SCM
 318 Note_collision_interface::automatic_shift (Grob *me,
 319                             Drul_array< Link_array <Grob> >
 320                             clash_groups)
 321 {
 322   Drul_array<Array<int> > shifts;
 323   SCM  tups = SCM_EOL;
 324
 325
 326   Direction d = UP;
 327   do
 328     {
 329       Array<int> & shift (shifts[d]);
 330       Link_array<Grob> & clashes (clash_groups[d]);
 331
 332       for (int i=0; i < clashes.size (); i++)
 333         {
 334           SCM sh
 335             = clashes[i]->get_grob_property ("horizontal-shift");
 336
 337           if (gh_number_p (sh))
 338             shift.push (gh_scm2int (sh));
 339           else
 340             shift.push (0);
 341         }
 342
 343       for (int i=1; i < shift.size (); i++)
 344         {
 345           if (shift[i-1] == shift[i])
 346             {
 347               clashes[0]->warning (_ ("Too many clashing notecolumns.  Ignoring them."));
 348               return tups;
 349             }
 350         }
 351     }
 352   while ((flip (&d))!= UP);
 353
 354   Drul_array< Array < Slice > > extents;
 355   Drul_array< Array < Real > > offsets;
 356   d = UP;
 357   do
 358     {
 359       for (int i=0; i < clash_groups[d].size (); i++)
 360         {
 361           Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
 362           s[LEFT] --;
 363           s[RIGHT]++;
 364           extents[d].push (s);
 365           offsets[d].push (d * 0.5 * i);
 366         }
 367     }
 368   while ((flip (&d))!= UP);
 369
 370   /*
 371     do horizontal shifts of each direction
 372
 373        |
 374       x||
 375        x||
 376         x|
 377    */
 378
 379   do
 380     {
 381       for (int i=1; i < clash_groups[d].size (); i++)
 382         {
 383           Slice prev =extents[d][i-1];
 384           prev.intersect (extents[d][i]);
 385           if (prev.length ()> 0 ||
 386  (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
 387             for (int j = i; j <  clash_groups[d].size (); j++)
 388               offsets[d][j] += d * 0.5;
 389         }
 390     }
 391   while ((flip (&d))!= UP);
 392
 393
 394   /*
 395     Check if chords are meshing
 396    */
 397
 398   check_meshing_chords (me, &offsets, extents, clash_groups);
 399
 400   do
 401     {
 402       for (int i=0; i < clash_groups[d].size (); i++)
 403         tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (),
 404                                  gh_double2scm (offsets[d][i])),
 405                         tups);
 406     }
 407   while (flip (&d) != UP);
 408   return tups;
 409 }
 410
 411
 412 SCM
 413 Note_collision_interface::forced_shift (Grob *me)
 414 {
 415   SCM tups = SCM_EOL;
 416
 417   SCM s = me->get_grob_property ("elements");
 418   for (; gh_pair_p (s); s = ly_cdr (s))
 419     {
 420       Grob * se = unsmob_grob (ly_car (s));
 421
 422       SCM force =  se->get_grob_property ("force-hshift");
 423       if (gh_number_p (force))
 424         {
 425           tups = gh_cons (gh_cons (se->self_scm (), force),
 426                           tups);
 427         }
 428     }
 429   return tups;
 430 }
 431
 432 void
 433 Note_collision_interface::add_column (Grob*me,Grob* ncol)
 434 {
 435   ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
 436   Axis_group_interface::add_element (me, ncol);
 437   me->add_dependency (ncol);
 438 }
 439
 440
 441 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
 442   "An object that handles collisions between notes with different stem "
 443 "directions and horizontal shifts. Most of the interesting properties "
 444 "are to be set in @ref{note-column-interface}: these are "
 445 "@code{force-hshift} and @code{horizontal-shift}. ",
 446   "merge-differently-dotted merge-differently-headed positioning-done");