lily/note-collision.cc

   1 /*
   2   collision.cc -- implement Collision
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "note-collision.hh"
  10
  11 #include "axis-group-interface.hh"
  12 #include "dot-column.hh"
  13 #include "international.hh"
  14 #include "note-column.hh"
  15 #include "note-head.hh"
  16 #include "output-def.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "item.hh"
  19 #include "rhythmic-head.hh"
  20 #include "staff-symbol-referencer.hh"
  21 #include "side-position-interface.hh"
  22 #include "stem.hh"
  23 #include "warn.hh"
  24
  25
  26 void
  27 check_meshing_chords (Grob *me,
  28                       Drul_array<vector<Real> > *offsets,
  29                       Drul_array<vector<Slice> > const &extents,
  30                       Drul_array<vector<Grob*> > const &clash_groups)
  31
  32 {
  33   if (!extents[UP].size () || ! extents[DOWN].size ())
  34     return;
  35
  36   Grob *cu = clash_groups[UP][0];
  37   Grob *cd = clash_groups[DOWN][0];
  38
  39   /* Every note column should have a stem, but avoid a crash. */
  40   if (!Note_column::get_stem (cu) || !Note_column::get_stem (cd))
  41     return;
  42
  43   Drul_array<Grob*> stems (Note_column::get_stem (cd),
  44                            Note_column::get_stem (cu));
  45
  46   Grob *nu = Note_column::first_head (cu);
  47   Grob *nd = Note_column::first_head (cd);
  48
  49   vector<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
  50   vector<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
  51
  52   /* Too far apart to collide.  */
  53   if (ups[0] > dps.back () + 1)
  54     return;
  55
  56   /* Merge heads if the notes lie the same line, or if the "stem-up-note" is
  57      above the "stem-down-note". */
  58   bool merge_possible = (ups[0] >= dps[0]) && (ups.back () >= dps.back ());
  59
  60   /* Do not merge notes typeset in different style. */
  61   if (!ly_is_equal (nu->get_property ("style"),
  62                     nd->get_property ("style")))
  63     merge_possible = false;
  64
  65   int upball_type = Rhythmic_head::duration_log (nu);
  66   int dnball_type = Rhythmic_head::duration_log (nd);
  67
  68   /* Do not merge whole notes (or longer, like breve, longa, maxima).  */
  69   if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
  70     merge_possible = false;
  71
  72   if (merge_possible
  73       && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
  74       && !to_boolean (me->get_property ("merge-differently-dotted")))
  75     merge_possible = false;
  76
  77   /* Can only merge different heads if merge-differently-headed is
  78      set. */
  79   if (merge_possible
  80       && upball_type != dnball_type
  81       && !to_boolean (me->get_property ("merge-differently-headed")))
  82     merge_possible = false;
  83
  84   if (merge_possible
  85       && nu->get_property ("style") == ly_symbol2scm ("fa")
  86       && nd->get_property ("style") == ly_symbol2scm ("fa"))
  87     {
  88       Interval uphead_size = nu->extent (nu, Y_AXIS);
  89       Offset att =  Offset (0.0, -1.0);
  90       nu->set_property ("stem-attachment", ly_offset2scm (att));
  91       nu->set_property ("transparent", SCM_BOOL_T);
  92     }
  93
  94   /* Should never merge quarter and half notes, as this would make
  95      them indistinguishable.  */
  96   if (merge_possible
  97       && ((Stem::duration_log (stems[UP]) == 1
  98            && Stem::duration_log (stems[DOWN]) == 2)
  99           || (Stem::duration_log (stems[UP]) == 2
 100               && Stem::duration_log (stems[DOWN]) == 1)))
 101     merge_possible = false;
 102
 103   /*
 104     this case (distant half collide),
 105
 106     |
 107     x |
 108     | x
 109     |
 110
 111     the noteheads may be closer than this case (close half collide)
 112
 113     |
 114     |
 115     x
 116     x
 117     |
 118     |
 119
 120   */
 121
 122   /* TODO: filter out the 'o's in this configuration, since they're no
 123      part in the collision.
 124
 125      |
 126      x|o
 127      x|o
 128      x
 129
 130   */
 131
 132   bool close_half_collide = false;
 133   bool distant_half_collide = false;
 134   bool full_collide = false;
 135
 136   for (vsize i = 0, j = 0; i < ups.size () && j < dps.size (); )
 137     {
 138       if (abs (ups[i] - dps[j]) == 1)
 139         {
 140           merge_possible = false;
 141           if (ups[i] > dps[j])
 142             close_half_collide = true;
 143           else
 144             distant_half_collide = true;
 145         }
 146       else if (ups[i] == dps[j])
 147         full_collide = true;
 148       else if (ups[i] > dps[0] && ups[i] < dps.back ())
 149         merge_possible = false;
 150       else if (dps[j] > ups[0] && dps[j] < ups.back ())
 151         merge_possible = false;
 152
 153       if (ups[i] < dps[j])
 154         i++;
 155       else if (ups[i] > dps[j])
 156         j++;
 157       else
 158         {
 159           i++;
 160           j++;
 161         }
 162     }
 163
 164   full_collide = full_collide || (close_half_collide
 165                                   && distant_half_collide);
 166
 167   Drul_array<Real> center_note_shifts;
 168   center_note_shifts[LEFT] = 0.0;
 169   center_note_shifts[RIGHT] = 0.0;
 170
 171   Real shift_amount = 1;
 172
 173   bool touch = (ups[0] >= dps.back ());
 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       /* If possible, don't wipe any heads. Else, wipe shortest head,
 191          or head with smallest amount of dots.  Note: when merging
 192          different heads, dots on the smaller one disappear. */
 193       Grob *wipe_ball = 0;
 194       Grob *dot_wipe_head = nu;
 195
 196       if (upball_type == dnball_type)
 197         {
 198           if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
 199             {
 200               wipe_ball = nd;
 201               dot_wipe_head = nd;
 202             }
 203           else if (Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu))
 204             {
 205               dot_wipe_head = nu;
 206               wipe_ball = nu;
 207             }
 208           else
 209             dot_wipe_head = nu;
 210         }
 211       else if (dnball_type > upball_type)
 212         {
 213           wipe_ball = nd;
 214           dot_wipe_head = nd;
 215         }
 216       else if (dnball_type < upball_type)
 217         {
 218           wipe_ball = nu;
 219           dot_wipe_head = nu;
 220         }
 221
 222       if (dot_wipe_head)
 223         {
 224           if (Grob *d = unsmob_grob (dot_wipe_head->get_object ("dot")))
 225             d->suicide ();
 226         }
 227
 228       if (wipe_ball && wipe_ball->is_live ())
 229         {
 230           wipe_ball->set_property ("transparent", SCM_BOOL_T);
 231         }
 232     }
 233   /* TODO: these numbers are magic; should devise a set of grob props
 234      to tune this behavior.  */
 235   else if (stem_to_stem)
 236     shift_amount = -abs (shift_amount) * 0.65;
 237   else if (close_half_collide && !touch)
 238     shift_amount *= 0.52;
 239   else if (distant_half_collide && !touch)
 240     shift_amount *= 0.4;
 241   else if (distant_half_collide || close_half_collide || full_collide)
 242     shift_amount *= 0.5;
 243
 244   /* we're meshing.  */
 245   else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
 246     shift_amount *= 0.1;
 247   else
 248     shift_amount *= 0.17;
 249
 250   /*
 251
 252   */
 253   if (full_collide
 254       && dnball_type * upball_type == 0)
 255     {
 256       if (upball_type == 0 && dnball_type == 1)
 257         shift_amount *= 1.25;
 258       else if (upball_type == 0 && dnball_type == 2)
 259         shift_amount *= 1.35;
 260       else if (dnball_type == 0 && upball_type == 1)
 261         shift_amount *= 0.7;
 262       else if (dnball_type == 0 && upball_type == 2)
 263         shift_amount *= 0.75;
 264     }
 265
 266   /*
 267    * Fix issue #44:
 268    *
 269    * Dots from left note head collide with right note head. Only occurs
 270    * with a close half collide, if the left note head is between
 271    * lines and the right note head is on a line, and if right note head
 272    * hasn't got any dots.
 273    */
 274   if (close_half_collide
 275       && Rhythmic_head::dot_count (nu)
 276       && !Rhythmic_head::dot_count (nd))
 277     {
 278       Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 279       if (!Staff_symbol_referencer::on_line (staff, ups[0]))
 280         {
 281           Grob *d = unsmob_grob (nu->get_object ("dot"));
 282           Grob *parent = d->get_parent (X_AXIS);
 283           if (Dot_column::has_interface (parent))
 284             Side_position_interface::add_support (parent, nd);
 285         }
 286     }
 287
 288   /* For full or close half collisions, the right hand head may
 289      obscure dots.  Move dots to the right.  */
 290   if (abs (shift_amount) > 1e-6
 291       && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
 292       && (full_collide || close_half_collide))
 293     {
 294       Grob *d = unsmob_grob (nd->get_object ("dot"));
 295       Grob *parent = d->get_parent (X_AXIS);
 296
 297       /*
 298         FIXME:
 299
 300         |
 301         x . o
 302         |
 303
 304
 305         the . is put right of o which is erroneous o force-shifted
 306         far to the right.
 307       */
 308       if (Dot_column::has_interface (parent))
 309         Side_position_interface::add_support (parent, nu);
 310     }
 311
 312   Direction d = UP;
 313   do
 314     {
 315       for (vsize i = 0; i < clash_groups[d].size (); i++)
 316         (*offsets)[d][i] += d * shift_amount;
 317     }
 318   while ((flip (&d)) != UP);
 319 }
 320
 321
 322 MAKE_SCHEME_CALLBACK(Note_collision_interface, calc_positioning_done, 1)
 323 SCM
 324 Note_collision_interface::calc_positioning_done (SCM smob)
 325 {
 326   Grob *me = unsmob_grob (smob);
 327   Drul_array<vector<Grob*> > cg = get_clash_groups (me);
 328
 329   Direction d = UP;
 330   do
 331     {
 332       for (vsize i = cg[d].size(); i--; )
 333         {
 334           /*
 335             Trigger positioning
 336            */
 337           cg[d][i]->extent (me, X_AXIS);
 338         }
 339     }
 340   while (flip (&d) != UP);
 341
 342   SCM autos (automatic_shift (me, cg));
 343   SCM hand (forced_shift (me));
 344
 345   Real wid = 0.0;
 346   do
 347     {
 348       if (cg[d].size ())
 349         {
 350           Grob *h = cg[d][0];
 351           Grob *fh = Note_column::first_head (h);
 352           if (fh)
 353             wid = fh->extent (h, X_AXIS).length ();
 354         }
 355     }
 356   while (flip (&d) != UP);
 357
 358   vector<Grob*> done;
 359   Real left_most = 1e6;
 360
 361   vector<Real> amounts;
 362   for (; scm_is_pair (hand); hand = scm_cdr (hand))
 363     {
 364       Grob *s = unsmob_grob (scm_caar (hand));
 365       Real amount = scm_to_double (scm_cdar (hand)) * wid;
 366
 367       done.push_back (s);
 368       amounts.push_back (amount);
 369       if (amount < left_most)
 370         left_most = amount;
 371     }
 372   for (; scm_is_pair (autos); autos = scm_cdr (autos))
 373     {
 374       Grob *s = unsmob_grob (scm_caar (autos));
 375       Real amount = scm_to_double (scm_cdar (autos)) * wid;
 376
 377       vsize x = find (done, s) - done.begin ();
 378       if (x == VPOS || x >= done.size ())
 379         {
 380           done.push_back (s);
 381           amounts.push_back (amount);
 382           if (amount < left_most)
 383             left_most = amount;
 384         }
 385     }
 386
 387   for (vsize i = 0; i < amounts.size (); i++)
 388     done[i]->translate_axis (amounts[i] - left_most, X_AXIS);
 389
 390   return SCM_BOOL_T;
 391 }
 392
 393 Drul_array < vector<Grob*> >
 394 Note_collision_interface::get_clash_groups (Grob *me)
 395 {
 396   Drul_array<vector<Grob*> > clash_groups;
 397
 398   extract_grob_set (me, "elements", elements);
 399   for (vsize i = 0; i < elements.size (); i++)
 400     {
 401       Grob *se = elements[i];
 402       if (Note_column::has_interface (se))
 403         {
 404           if (!Note_column::dir (se))
 405             {
 406               se->programming_error ("note-column has no direction");
 407             }
 408           else
 409             clash_groups[Note_column::dir (se)].push_back (se);
 410         }
 411     }
 412
 413   Direction d = UP;
 414   do
 415     {
 416       vector<Grob*> &clashes (clash_groups[d]);
 417       vector_sort (clashes, Note_column::shift_less);
 418     }
 419   while ((flip (&d)) != UP);
 420
 421   return clash_groups;
 422 }
 423
 424 /** This complicated routine moves note columns around horizontally to
 425     ensure that notes don't clash.
 426
 427 */
 428 SCM
 429 Note_collision_interface::automatic_shift (Grob *me,
 430                                            Drul_array < vector<Grob*>
 431                                            > clash_groups)
 432 {
 433   Drul_array < vector<int> > shifts;
 434   SCM tups = SCM_EOL;
 435
 436   Direction d = UP;
 437   do
 438     {
 439       vector<int> &shift (shifts[d]);
 440       vector<Grob*> &clashes (clash_groups[d]);
 441
 442       for (vsize i = 0; i < clashes.size (); i++)
 443         {
 444           SCM sh
 445             = clashes[i]->get_property ("horizontal-shift");
 446
 447           if (scm_is_number (sh))
 448             shift.push_back (scm_to_int (sh));
 449           else
 450             shift.push_back (0);
 451         }
 452
 453       for (vsize i = 1; i < shift.size (); i++)
 454         {
 455           if (shift[i - 1] == shift[i])
 456             {
 457               clashes[0]->warning (_ ("ignoring too many clashing note columns"));
 458               return tups;
 459             }
 460         }
 461     }
 462   while ((flip (&d)) != UP);
 463
 464   Drul_array<vector<Slice> > extents;
 465   Drul_array<vector<Real> > offsets;
 466   d = UP;
 467   do
 468     {
 469       for (vsize i = 0; i < clash_groups[d].size (); i++)
 470         {
 471           Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
 472           s[LEFT]--;
 473           s[RIGHT]++;
 474           extents[d].push_back (s);
 475           offsets[d].push_back (d * 0.5 * i);
 476         }
 477     }
 478   while ((flip (&d)) != UP);
 479
 480   /*
 481     do horizontal shifts of each direction
 482
 483     |
 484     x||
 485     x||
 486     x|
 487   */
 488
 489   do
 490     {
 491       for (vsize i = 1; i < clash_groups[d].size (); i++)
 492         {
 493           Slice prev = extents[d][i - 1];
 494           prev.intersect (extents[d][i]);
 495           if (prev.length () > 0
 496               || (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
 497             for (vsize j = i; j < clash_groups[d].size (); j++)
 498               offsets[d][j] += d * 0.5;
 499         }
 500     }
 501   while ((flip (&d)) != UP);
 502
 503   /*
 504     Check if chords are meshing
 505   */
 506
 507   check_meshing_chords (me, &offsets, extents, clash_groups);
 508
 509   do
 510     {
 511       for (vsize i = 0; i < clash_groups[d].size (); i++)
 512         tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
 513                                    scm_from_double (offsets[d][i])),
 514                          tups);
 515     }
 516   while (flip (&d) != UP);
 517
 518   return tups;
 519 }
 520
 521 SCM
 522 Note_collision_interface::forced_shift (Grob *me)
 523 {
 524   SCM tups = SCM_EOL;
 525
 526   extract_grob_set (me, "elements", elements);
 527   for (vsize i = 0; i < elements.size (); i++)
 528     {
 529       Grob *se = elements[i];
 530
 531       SCM force = se->get_property ("force-hshift");
 532       if (scm_is_number (force))
 533         {
 534           tups = scm_cons (scm_cons (se->self_scm (), force),
 535                            tups);
 536         }
 537     }
 538   return tups;
 539 }
 540
 541 void
 542 Note_collision_interface::add_column (Grob *me, Grob *ncol)
 543 {
 544   ncol->set_property ("X-offset", Grob::x_parent_positioning_proc);
 545   Axis_group_interface::add_element (me, ncol);
 546 }
 547
 548 ADD_INTERFACE (Note_collision_interface,
 549                "An object that handles collisions between notes with different stem "
 550                "directions and horizontal shifts. Most of the interesting properties "
 551                "are to be set in @ref{note-column-interface}: these are "
 552                "@code{force-hshift} and @code{horizontal-shift}.",
 553
 554                /* properties */
 555                "ignore-collision "
 556                "merge-differently-dotted "
 557                "merge-differently-headed "
 558                "positioning-done ");