lily/note-collision.cc

   1 /*
   2   collision.cc -- implement Collision
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2006 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    * Fix issue #44:
 252    *
 253    * Dots from left note head collide with right note head. Only occurs
 254    * with a close half collide, if the left note head is between
 255    * lines and the right note head is on a line, and if right note head
 256    * hasn't got any dots.
 257    */
 258   if (close_half_collide
 259       && Rhythmic_head::dot_count (nu)
 260       && !Rhythmic_head::dot_count (nd))
 261     {
 262       Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
 263       if (!Staff_symbol_referencer::on_line (staff, ups[0]))
 264         {
 265           Grob *d = unsmob_grob (nu->get_object ("dot"));
 266           Grob *parent = d->get_parent (X_AXIS);
 267           if (Dot_column::has_interface (parent))
 268             Side_position_interface::add_support (parent, nd);
 269         }
 270     }
 271
 272   /* For full or close half collisions, the right hand head may
 273      obscure dots.  Move dots to the right.  */
 274   if (abs (shift_amount) > 1e-6
 275       && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
 276       && (full_collide || close_half_collide))
 277     {
 278       Grob *d = unsmob_grob (nd->get_object ("dot"));
 279       Grob *parent = d->get_parent (X_AXIS);
 280
 281       /*
 282         FIXME:
 283
 284         |
 285         x . o
 286         |
 287
 288
 289         the . is put right of o which is erroneous o force-shifted
 290         far to the right.
 291       */
 292       if (Dot_column::has_interface (parent))
 293         Side_position_interface::add_support (parent, nu);
 294     }
 295
 296   Direction d = UP;
 297   do
 298     {
 299       for (vsize i = 0; i < clash_groups[d].size (); i++)
 300         (*offsets)[d][i] += d * shift_amount;
 301     }
 302   while ((flip (&d)) != UP);
 303 }
 304
 305
 306 MAKE_SCHEME_CALLBACK(Note_collision_interface, calc_positioning_done, 1)
 307 SCM
 308 Note_collision_interface::calc_positioning_done (SCM smob)
 309 {
 310   Grob *me = unsmob_grob (smob);
 311   Drul_array<vector<Grob*> > cg = get_clash_groups (me);
 312
 313   Direction d = UP;
 314   do
 315     {
 316       for (vsize i = cg[d].size(); i--; )
 317         {
 318           /*
 319             Trigger positioning
 320            */
 321           cg[d][i]->extent (me, X_AXIS);
 322         }
 323     }
 324   while (flip (&d) != UP);
 325
 326   SCM autos (automatic_shift (me, cg));
 327   SCM hand (forced_shift (me));
 328
 329   Real wid = 0.0;
 330   do
 331     {
 332       if (cg[d].size ())
 333         {
 334           Grob *h = cg[d][0];
 335           Grob *fh = Note_column::first_head (h);
 336           if (fh)
 337             wid = fh->extent (h, X_AXIS).length ();
 338         }
 339     }
 340   while (flip (&d) != UP);
 341
 342   vector<Grob*> done;
 343   Real left_most = 1e6;
 344
 345   vector<Real> amounts;
 346   for (; scm_is_pair (hand); hand = scm_cdr (hand))
 347     {
 348       Grob *s = unsmob_grob (scm_caar (hand));
 349       Real amount = scm_to_double (scm_cdar (hand)) * wid;
 350
 351       done.push_back (s);
 352       amounts.push_back (amount);
 353       if (amount < left_most)
 354         left_most = amount;
 355     }
 356   for (; scm_is_pair (autos); autos = scm_cdr (autos))
 357     {
 358       Grob *s = unsmob_grob (scm_caar (autos));
 359       Real amount = scm_to_double (scm_cdar (autos)) * wid;
 360
 361       vsize x = find (done, s) - done.begin ();
 362       if (x == VPOS || x >= done.size ())
 363         {
 364           done.push_back (s);
 365           amounts.push_back (amount);
 366           if (amount < left_most)
 367             left_most = amount;
 368         }
 369     }
 370
 371   for (vsize i = 0; i < amounts.size (); i++)
 372     done[i]->translate_axis (amounts[i] - left_most, X_AXIS);
 373
 374   return SCM_BOOL_T;
 375 }
 376
 377 Drul_array < vector<Grob*> >
 378 Note_collision_interface::get_clash_groups (Grob *me)
 379 {
 380   Drul_array<vector<Grob*> > clash_groups;
 381
 382   extract_grob_set (me, "elements", elements);
 383   for (vsize i = 0; i < elements.size (); i++)
 384     {
 385       Grob *se = elements[i];
 386       if (Note_column::has_interface (se))
 387         {
 388           if (!Note_column::dir (se))
 389             {
 390               se->programming_error ("note-column has no direction");
 391             }
 392           else
 393             clash_groups[Note_column::dir (se)].push_back (se);
 394         }
 395     }
 396
 397   Direction d = UP;
 398   do
 399     {
 400       vector<Grob*> &clashes (clash_groups[d]);
 401       vector_sort (clashes, Note_column::shift_less);
 402     }
 403   while ((flip (&d)) != UP);
 404
 405   return clash_groups;
 406 }
 407
 408 /** This complicated routine moves note columns around horizontally to
 409     ensure that notes don't clash.
 410
 411     This should be put into Scheme.
 412 */
 413 SCM
 414 Note_collision_interface::automatic_shift (Grob *me,
 415                                            Drul_array < vector<Grob*>
 416                                            > clash_groups)
 417 {
 418   Drul_array < vector<int> > shifts;
 419   SCM tups = SCM_EOL;
 420
 421   Direction d = UP;
 422   do
 423     {
 424       vector<int> &shift (shifts[d]);
 425       vector<Grob*> &clashes (clash_groups[d]);
 426
 427       for (vsize i = 0; i < clashes.size (); i++)
 428         {
 429           SCM sh
 430             = clashes[i]->get_property ("horizontal-shift");
 431
 432           if (scm_is_number (sh))
 433             shift.push_back (scm_to_int (sh));
 434           else
 435             shift.push_back (0);
 436         }
 437
 438       for (vsize i = 1; i < shift.size (); i++)
 439         {
 440           if (shift[i - 1] == shift[i])
 441             {
 442               clashes[0]->warning (_ ("ignoring too many clashing note columns"));
 443               return tups;
 444             }
 445         }
 446     }
 447   while ((flip (&d)) != UP);
 448
 449   Drul_array<vector<Slice> > extents;
 450   Drul_array<vector<Real> > offsets;
 451   d = UP;
 452   do
 453     {
 454       for (vsize i = 0; i < clash_groups[d].size (); i++)
 455         {
 456           Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
 457           s[LEFT]--;
 458           s[RIGHT]++;
 459           extents[d].push_back (s);
 460           offsets[d].push_back (d * 0.5 * i);
 461         }
 462     }
 463   while ((flip (&d)) != UP);
 464
 465   /*
 466     do horizontal shifts of each direction
 467
 468     |
 469     x||
 470     x||
 471     x|
 472   */
 473
 474   do
 475     {
 476       for (vsize i = 1; i < clash_groups[d].size (); i++)
 477         {
 478           Slice prev = extents[d][i - 1];
 479           prev.intersect (extents[d][i]);
 480           if (prev.length () > 0
 481               || (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
 482             for (vsize j = i; j < clash_groups[d].size (); j++)
 483               offsets[d][j] += d * 0.5;
 484         }
 485     }
 486   while ((flip (&d)) != UP);
 487
 488   /*
 489     Check if chords are meshing
 490   */
 491
 492   check_meshing_chords (me, &offsets, extents, clash_groups);
 493
 494   do
 495     {
 496       for (vsize i = 0; i < clash_groups[d].size (); i++)
 497         tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
 498                                    scm_from_double (offsets[d][i])),
 499                          tups);
 500     }
 501   while (flip (&d) != UP);
 502
 503   return tups;
 504 }
 505
 506 SCM
 507 Note_collision_interface::forced_shift (Grob *me)
 508 {
 509   SCM tups = SCM_EOL;
 510
 511   extract_grob_set (me, "elements", elements);
 512   for (vsize i = 0; i < elements.size (); i++)
 513     {
 514       Grob *se = elements[i];
 515
 516       SCM force = se->get_property ("force-hshift");
 517       if (scm_is_number (force))
 518         {
 519           tups = scm_cons (scm_cons (se->self_scm (), force),
 520                            tups);
 521         }
 522     }
 523   return tups;
 524 }
 525
 526 void
 527 Note_collision_interface::add_column (Grob *me, Grob *ncol)
 528 {
 529   ncol->set_property ("X-offset", Grob::x_parent_positioning_proc);
 530   Axis_group_interface::add_element (me, ncol);
 531 }
 532
 533 ADD_INTERFACE (Note_collision_interface,
 534                "An object that handles collisions between notes with different stem "
 535                "directions and horizontal shifts. Most of the interesting properties "
 536                "are to be set in @ref{note-column-interface}: these are "
 537                "@code{force-hshift} and @code{horizontal-shift}.",
 538
 539                /* properties */
 540                "merge-differently-dotted "
 541                "merge-differently-headed "
 542                "positioning-done ");