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   full_collide = full_collide || (close_half_collide
 164                                   && distant_half_collide);
 165
 166   Drul_array<Real> center_note_shifts;
 167   center_note_shifts[LEFT] = 0.0;
 168   center_note_shifts[RIGHT] = 0.0;
 169
 170
 171   Real shift_amount = 1;
 172
 173   bool touch = (ups[0] >= dps.top ());
 174   if (touch)
 175     shift_amount *= -1;
 176
 177   /* For full collisions, the right hand head may obscure dots, so
 178      make sure the dotted heads go to the right.  */
 179   bool stem_to_stem = false;
 180   if (full_collide)
 181     if (Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd))
 182       shift_amount = 1;
 183     else if (Rhythmic_head::dot_count (nu) < Rhythmic_head::dot_count (nd))
 184       stem_to_stem = true;
 185
 186   if (merge_possible)
 187     {
 188       shift_amount = 0;
 189
 190
 191       /* If possible, don't wipe any heads. Else, wipe shortest head,
 192          or head with smallest amount of dots.  Note: when merging
 193          different heads, dots on the smaller one disappear. */
 194       Grob *wipe_ball = 0;
 195       Grob *dot_wipe_head = nu;
 196
 197       if (upball_type == dnball_type)
 198         {
 199           if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
 200             {
 201               wipe_ball = nd;
 202               dot_wipe_head = nd;
 203             }
 204           else if (Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu))
 205             {
 206               dot_wipe_head = nu;
 207               wipe_ball = nu;
 208             }
 209           else
 210             {
 211               dot_wipe_head = nu;
 212             }
 213         }
 214       else if (dnball_type > upball_type)
 215         {
 216           wipe_ball = nd;
 217           dot_wipe_head = nd;
 218         }
 219       else if (dnball_type < upball_type)
 220         {
 221           wipe_ball = nu;
 222           dot_wipe_head = nu;
 223         }
 224
 225       if (dot_wipe_head)
 226         {
 227           if (Grob *d = unsmob_grob (dot_wipe_head->get_grob_property ("dot")))
 228             d->suicide ();
 229         }
 230
 231       if (wipe_ball && wipe_ball->live ())
 232         {
 233           wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
 234           wipe_ball->set_grob_property ("stencil", SCM_EOL);
 235         }
 236     }
 237   /* TODO: these numbers are magic; should devise a set of grob props
 238      to tune this behavior.  */
 239   else if (stem_to_stem)
 240     shift_amount *= -0.65;
 241   else if (close_half_collide && !touch)
 242     shift_amount *= 0.52;
 243   else if (distant_half_collide && !touch)
 244     shift_amount *= 0.4;
 245   else if (distant_half_collide || close_half_collide || full_collide)
 246     shift_amount *= 0.5;
 247
 248   /* we're meshing.  */
 249   else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
 250     shift_amount *= 0.1;
 251   else
 252     shift_amount *= 0.25;
 253
 254   /* For full or close half collisions, the right hand head may
 255      obscure dots.  Move dots to the right.  */
 256   if (abs (shift_amount) > 1e-6
 257       && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
 258       && (full_collide || close_half_collide))
 259     {
 260       Grob *d = unsmob_grob (nd->get_grob_property ("dot"));
 261       Grob *parent = d->get_parent (X_AXIS);
 262       if (Dot_column::has_interface (parent))
 263         Side_position_interface::add_support (parent, nu);
 264     }
 265
 266   Direction d = UP;
 267   do
 268     {
 269       for (int i=0; i < clash_groups[d].size (); i++)
 270         (*offsets)[d][i] += d * shift_amount;
 271     }
 272   while ((flip (&d))!= UP);
 273 }
 274
 275 void
 276 Note_collision_interface::do_shifts (Grob* me)
 277 {
 278   Drul_array< Link_array <Grob>  > cg = get_clash_groups (me);
 279
 280   SCM autos (automatic_shift (me, cg));
 281   SCM hand (forced_shift (me));
 282
 283   Direction d = UP;
 284   Real wid = 0.0;
 285   do
 286     {
 287       if(cg[d].size())
 288         {
 289           Grob  *h = cg[d][0];
 290           wid = Note_column::first_head (h)->extent (h,X_AXIS).length() ;
 291         }
 292     }
 293   while (flip (&d) != UP);
 294
 295   Link_array<Grob> done;
 296   for (; gh_pair_p (hand); hand =ly_cdr (hand))
 297     {
 298       Grob * s = unsmob_grob (ly_caar (hand));
 299       Real amount = gh_scm2double (ly_cdar (hand));
 300
 301       s->translate_axis (amount *wid, X_AXIS);
 302       done.push (s);
 303     }
 304   for (; gh_pair_p (autos); autos =ly_cdr (autos))
 305     {
 306       Grob * s = unsmob_grob (ly_caar (autos));
 307       Real amount = gh_scm2double (ly_cdar (autos));
 308
 309       if (!done.find (s))
 310         s->translate_axis (amount * wid, X_AXIS);
 311     }
 312 }
 313
 314 Drul_array< Link_array <Grob>  >
 315 Note_collision_interface::get_clash_groups (Grob *me)
 316 {
 317   Drul_array<Link_array<Grob> > clash_groups;
 318
 319   SCM s = me->get_grob_property ("elements");
 320   for (; gh_pair_p (s); s = ly_cdr (s))
 321     {
 322       SCM car = ly_car (s);
 323
 324       Grob * se = unsmob_grob (car);
 325       if (Note_column::has_interface (se))
 326         clash_groups[Note_column::dir (se)].push (se);
 327     }
 328
 329   Direction d = UP;
 330   do
 331     {
 332       Link_array<Grob> & clashes (clash_groups[d]);
 333       clashes.sort (Note_column::shift_compare);
 334     }
 335   while ((flip (&d))!= UP);
 336
 337   return clash_groups;
 338 }
 339
 340 /** This complicated routine moves note columns around horizontally to
 341   ensure that notes don't clash.
 342
 343   This should be put into Scheme.
 344   */
 345 SCM
 346 Note_collision_interface::automatic_shift (Grob *me,
 347                             Drul_array< Link_array <Grob> >
 348                             clash_groups)
 349 {
 350   Drul_array<Array<int> > shifts;
 351   SCM  tups = SCM_EOL;
 352
 353
 354   Direction d = UP;
 355   do
 356     {
 357       Array<int> & shift (shifts[d]);
 358       Link_array<Grob> & clashes (clash_groups[d]);
 359
 360       for (int i=0; i < clashes.size (); i++)
 361         {
 362           SCM sh
 363             = clashes[i]->get_grob_property ("horizontal-shift");
 364
 365           if (gh_number_p (sh))
 366             shift.push (gh_scm2int (sh));
 367           else
 368             shift.push (0);
 369         }
 370
 371       for (int i=1; i < shift.size (); i++)
 372         {
 373           if (shift[i-1] == shift[i])
 374             {
 375               clashes[0]->warning (_ ("Too many clashing notecolumns.  Ignoring them."));
 376               return tups;
 377             }
 378         }
 379     }
 380   while ((flip (&d))!= UP);
 381
 382   Drul_array< Array < Slice > > extents;
 383   Drul_array< Array < Real > > offsets;
 384   d = UP;
 385   do
 386     {
 387       for (int i=0; i < clash_groups[d].size (); i++)
 388         {
 389           Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
 390           s[LEFT] --;
 391           s[RIGHT]++;
 392           extents[d].push (s);
 393           offsets[d].push (d * 0.5 * i);
 394         }
 395     }
 396   while ((flip (&d))!= UP);
 397
 398   /*
 399     do horizontal shifts of each direction
 400
 401        |
 402       x||
 403        x||
 404         x|
 405    */
 406
 407   do
 408     {
 409       for (int i=1; i < clash_groups[d].size (); i++)
 410         {
 411           Slice prev =extents[d][i-1];
 412           prev.intersect (extents[d][i]);
 413           if (prev.length ()> 0 ||
 414  (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
 415             for (int j = i; j <  clash_groups[d].size (); j++)
 416               offsets[d][j] += d * 0.5;
 417         }
 418     }
 419   while ((flip (&d))!= UP);
 420
 421
 422   /*
 423     Check if chords are meshing
 424    */
 425
 426   check_meshing_chords (me, &offsets, extents, clash_groups);
 427
 428   do
 429     {
 430       for (int i=0; i < clash_groups[d].size (); i++)
 431         tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (),
 432                                  gh_double2scm (offsets[d][i])),
 433                         tups);
 434     }
 435   while (flip (&d) != UP);
 436   return tups;
 437 }
 438
 439
 440 SCM
 441 Note_collision_interface::forced_shift (Grob *me)
 442 {
 443   SCM tups = SCM_EOL;
 444
 445   SCM s = me->get_grob_property ("elements");
 446   for (; gh_pair_p (s); s = ly_cdr (s))
 447     {
 448       Grob * se = unsmob_grob (ly_car (s));
 449
 450       SCM force =  se->get_grob_property ("force-hshift");
 451       if (gh_number_p (force))
 452         {
 453           tups = gh_cons (gh_cons (se->self_scm (), force),
 454                           tups);
 455         }
 456     }
 457   return tups;
 458 }
 459
 460 void
 461 Note_collision_interface::add_column (Grob*me,Grob* ncol)
 462 {
 463   ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
 464   Axis_group_interface::add_element (me, ncol);
 465   me->add_dependency (ncol);
 466 }
 467
 468
 469 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
 470                "An object that handles collisions between notes with different stem "
 471                "directions and horizontal shifts. Most of the interesting properties "
 472                "are to be set in @ref{note-column-interface}: these are "
 473                "@code{force-hshift} and @code{horizontal-shift}."
 474
 475                ,
 476
 477                "merge-differently-dotted merge-differently-headed positioning-done");