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