lily/slur-configuration.cc

   1 /*
   2   slur-configuration.cc -- implement Slur_configuration
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "slur-configuration.hh"
  10
  11
  12 #include "stem.hh"
  13 #include "warn.hh"
  14 #include "misc.hh"
  15 #include "item.hh"
  16 #include "pointer-group-interface.hh"
  17 #include "slur.hh"
  18 #include "slur-scoring.hh"
  19 #include "spanner.hh"
  20 #include "staff-symbol-referencer.hh"
  21 #include "libc-extension.hh"
  22
  23 Bezier
  24 avoid_staff_line (Slur_score_state const &state,
  25                   Bezier bez)
  26 {
  27   Offset horiz (1, 0);
  28   Array<Real> ts = bez.solve_derivative (horiz);
  29
  30   /* TODO: handle case of broken slur.  */
  31   if (!ts.is_empty ()
  32       && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
  33       && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
  34     {
  35       Real y = bez.curve_point (ts[0])[Y_AXIS];
  36
  37       Grob *staff = state.extremes_[LEFT].staff_;
  38
  39       Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
  40         / state.staff_space_;
  41
  42       Real distance = fabs (my_round (p) - p);  //  in halfspaces
  43       if (distance < 4 * state.thickness_
  44           && (int) fabs (my_round (p))
  45           <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
  46           && (int (fabs (my_round (p))) % 2
  47               != Staff_symbol_referencer::line_count (staff) % 2))
  48         {
  49           Direction resolution_dir
  50             = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
  51
  52           // TODO: parameter
  53           Real newp = my_round (p) + resolution_dir
  54             * 5 * state.thickness_;
  55
  56           Real dy = (newp - p) * state.staff_space_ / 2.0;
  57
  58           bez.control_[1][Y_AXIS] += dy;
  59           bez.control_[2][Y_AXIS] += dy;
  60         }
  61     }
  62   return bez;
  63 }
  64
  65 Real
  66 fit_factor (Offset dz_unit, Offset dz_perp,
  67             Bezier curve, Direction d, Array<Offset> const &avoid)
  68 {
  69   Real fit_factor = 0.0;
  70   Offset x0 = curve.control_[0];
  71   curve.translate (-x0);
  72   curve.rotate (-dz_unit.arg ());
  73   curve.scale (1, d);
  74
  75   Interval curve_xext;
  76   curve_xext.add_point (curve.control_[0][X_AXIS]);
  77   curve_xext.add_point (curve.control_[3][X_AXIS]);
  78
  79   for (int i = 0; i < avoid.size (); i++)
  80     {
  81       Offset z = (avoid[i] - x0);
  82       Offset p (dot_product (z, dz_unit),
  83                 d * dot_product (z, dz_perp));
  84       if (!curve_xext.contains (p[X_AXIS]))
  85         continue;
  86
  87       Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
  88       if (y)
  89         fit_factor = max (fit_factor, (p[Y_AXIS] / y));
  90     }
  91   return fit_factor;
  92 }
  93
  94 void
  95 Slur_configuration::generate_curve (Slur_score_state const &state,
  96                                     Real r_0, Real h_inf,
  97                                     Array<Offset> const &avoid)
  98 {
  99   Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
 100   Offset dz_unit = dz;
 101   dz_unit *= 1 / dz.length ();
 102   Offset dz_perp = dz_unit * Offset (0, 1);
 103
 104   Real indent, height;
 105   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
 106
 107   Real len = dz.length ();
 108
 109   /* This condition,
 110
 111   len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
 112
 113   is equivalent to:
 114
 115   |bez' (0)| < | bez' (.5)|
 116
 117   when (control2 - control1) has the same direction as
 118   (control3 - control0).  */
 119
 120   Real max_indent = len / 3.1;
 121   indent = min (indent, max_indent);
 122
 123   Real a1 = sqr (len) / 3.0;
 124   Real a2 = 0.75 * sqr (indent + len / 3.0);
 125   Real max_h = a1 - a2;
 126
 127   if (max_h < 0)
 128     {
 129       programming_error ("slur indent too small");
 130       max_h = len / 3.0;
 131     }
 132   else
 133     max_h = sqrt (max_h);
 134
 135   Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
 136
 137   Real x1 = (eccentricity + indent);
 138   Real x2 = (eccentricity - indent);
 139
 140   Bezier curve;
 141   curve.control_[0] = attachment_[LEFT];
 142   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 143     + dz_unit * x1;
 144   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 145     + dz_unit * x2;
 146   curve.control_[3] = attachment_[RIGHT];
 147
 148   Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
 149
 150   height = max (height, min (height * ff, max_h));
 151
 152   curve.control_[0] = attachment_[LEFT];
 153   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 154     + dz_unit * x1;
 155   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 156     + dz_unit * x2;
 157   curve.control_[3] = attachment_[RIGHT];
 158
 159   curve_ = avoid_staff_line (state, curve);
 160   height_ = height;
 161 }
 162
 163 Slur_configuration::Slur_configuration ()
 164 {
 165   score_ = 0.0;
 166   index_ = -1;
 167 };
 168
 169 void
 170 Slur_configuration::score_encompass (Slur_score_state const &state)
 171 {
 172   Bezier const &bez (curve_);
 173   Real demerit = 0.0;
 174
 175   /*
 176     Distances for heads that are between slur and line between
 177     attachment points.
 178   */
 179   Array<Real> convex_head_distances;
 180   for (int j = 0; j < state.encompass_infos_.size (); j++)
 181     {
 182       Real x = state.encompass_infos_[j].x_;
 183
 184       bool l_edge = j == 0;
 185       bool r_edge = j == state.encompass_infos_.size () - 1;
 186       bool edge = l_edge || r_edge;
 187
 188       if (! (x < attachment_[RIGHT][X_AXIS]
 189              && x > attachment_[LEFT][X_AXIS]))
 190         continue;
 191
 192       Real y = bez.get_other_coordinate (X_AXIS, x);
 193       if (!edge)
 194         {
 195           Real head_dy = (y - state.encompass_infos_[j].head_);
 196           if (state.dir_ * head_dy < 0)
 197             {
 198               demerit += state.parameters_.head_encompass_penalty_;
 199               convex_head_distances.push (0.0);
 200             }
 201           else
 202             {
 203               Real hd = (head_dy)
 204                 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 205                 : state.parameters_.head_encompass_penalty_;
 206               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
 207
 208               demerit += hd;
 209             }
 210
 211           Real line_y = linear_interpolate (x,
 212                                             attachment_[RIGHT][X_AXIS],
 213                                             attachment_[LEFT][X_AXIS],
 214                                             attachment_[RIGHT][Y_AXIS],
 215                                             attachment_[LEFT][Y_AXIS]);
 216
 217           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 218             {
 219
 220               Real closest
 221                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
 222               Real d = fabs (closest - y);
 223
 224               convex_head_distances.push (d);
 225             }
 226         }
 227
 228       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 229         {
 230           Real stem_dem = state.parameters_.stem_encompass_penalty_;
 231           if ((l_edge && state.dir_ == UP)
 232               || (r_edge && state.dir_ == DOWN))
 233             stem_dem /= 5;
 234
 235           demerit += stem_dem;
 236         }
 237       else if (!edge)
 238         {
 239           Interval ext;
 240           ext.add_point (state.encompass_infos_[j].stem_);
 241           ext.add_point (state.encompass_infos_[j].head_);
 242
 243           // ?
 244           demerit += -state.parameters_.closeness_factor_
 245             * min (state.dir_
 246                    * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
 247             / state.encompass_infos_.size ();
 248         }
 249     }
 250
 251   Real variance_penalty = 0.0;
 252
 253   if (convex_head_distances.size ())
 254     {
 255       Real avg_distance = 0.0;
 256       Real min_dist = infinity_f;
 257       for (int j = 0; j < convex_head_distances.size (); j++)
 258         {
 259           min_dist = min (min_dist, convex_head_distances[j]);
 260           avg_distance += convex_head_distances[j];
 261         }
 262
 263       /*
 264         For slurs over 3 or 4 heads, the average distance is not a
 265         good normalizer.
 266       */
 267       Real n = convex_head_distances.size ();
 268       if (n <= 2)
 269         {
 270           Real fact = 1.0;
 271           avg_distance += height_ * fact;
 272           n += fact;
 273         }
 274
 275       /*
 276         TODO: maybe it's better to use (avgdist - mindist)*factor
 277         as penalty.
 278       */
 279       avg_distance /= n;
 280       variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 281       if (min_dist > 0.0)
 282         variance_penalty
 283           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
 284
 285       variance_penalty = max (variance_penalty, 0.0);
 286       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 287     }
 288
 289 #if DEBUG_SLUR_SCORING
 290   score_card_ += to_string ("C%.2f", demerit);
 291   score_card_ += to_string ("D%.2f", variance_penalty);
 292 #endif
 293
 294   score_ += demerit + variance_penalty;
 295 }
 296
 297 void
 298 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 299 {
 300   Real demerit = 0.0;
 301   for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
 302     {
 303       Drul_array<Offset> attachment = attachment_;
 304       Extra_collision_info const &info (state.extra_encompass_infos_[j]);
 305
 306       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 307
 308       /*
 309         to prevent numerical inaccuracies in
 310         Bezier::get_other_coordinate ().
 311       */
 312       Direction d = LEFT;
 313       bool found = false;
 314       Real y = 0.0;
 315
 316       do
 317         {
 318           /*
 319             We need to check for the bound explicitly, since the
 320             slur-ending can be almost vertical, making the Y
 321             coordinate a bad approximation of the object-slur
 322             distance.
 323           */
 324           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
 325           if (!as_item)
 326             continue;
 327
 328           Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
 329           item_x.intersect (state.extremes_[d].slur_head_x_extent_);
 330           if (!item_x.is_empty ())
 331             {
 332               y = attachment[d][Y_AXIS];
 333               found = true;
 334             }
 335
 336         }
 337       while (flip (&d) != LEFT);
 338
 339       if (!found)
 340         {
 341           Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
 342
 343           if (!slur_wid.contains (x))
 344             continue;
 345
 346           y = curve_.get_other_coordinate (X_AXIS, x);
 347         }
 348
 349       Real dist = 0.0;
 350       if (info.type_ == ly_symbol2scm ("around"))
 351         dist = info.extents_[Y_AXIS].distance (y);
 352
 353       /*
 354         Have to score too: the curve enumeration is limited in its
 355         shape, and may produce curves which collide anyway.
 356        */
 357       else if (info.type_ == ly_symbol2scm ("inside"))
 358         dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
 359       else
 360         programming_error ("unknown avoidance type");
 361
 362       Real epsilon = 0.1;
 363       Real factor
 364         = (1.0 / (max (dist, 0.0) + epsilon * state.parameters_.extra_encompass_free_distance_));
 365       Real threshold
 366         = 1.0 / ((1 + epsilon) * state.parameters_.extra_encompass_free_distance_);
 367
 368       demerit
 369         += max (info.penalty_ * (factor - threshold), 0.0);
 370     }
 371 #if DEBUG_SLUR_SCORING
 372   score_card_ += to_string ("X%.2f", demerit);
 373 #endif
 374
 375   score_ += demerit;
 376 }
 377
 378 void
 379 Slur_configuration::score_edges (Slur_score_state const &state)
 380 {
 381   Direction d = LEFT;
 382   Offset dz = attachment_[RIGHT]
 383     - attachment_[LEFT];
 384   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 385   do
 386     {
 387       Real y = attachment_[d][Y_AXIS];
 388       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 389
 390       Real factor = state.parameters_.edge_attraction_factor_;
 391       Real demerit = factor * dy;
 392       if (state.extremes_[d].stem_
 393           && state.extremes_[d].stem_dir_ == state.dir_
 394           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
 395         demerit /= 5;
 396
 397       demerit *= exp (state.dir_ * d * slope
 398                       * state.parameters_.edge_slope_exponent_);
 399
 400       score_ += demerit;
 401 #if DEBUG_SLUR_SCORING
 402       score_card_ += to_string ("E%.2f", demerit);
 403 #endif
 404     }
 405   while (flip (&d) != LEFT);
 406 }
 407
 408 void
 409 Slur_configuration ::score_slopes (Slur_score_state const &state)
 410 {
 411   Real dy = state.musical_dy_;
 412   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
 413   Real slur_dy = slur_dz[Y_AXIS];
 414   Real demerit = 0.0;
 415
 416   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 417                    - state.parameters_.max_slope_), 0.0)
 418     * state.parameters_.max_slope_factor_;
 419
 420   /* 0.2: account for staffline offset. */
 421   Real max_dy = (fabs (dy) + 0.2);
 422   if (state.edge_has_beams_)
 423     max_dy += 1.0;
 424
 425   if (!state.is_broken_)
 426     demerit += state.parameters_.steeper_slope_factor_
 427       * (max (fabs (slur_dy) -max_dy, 0.0));
 428
 429   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 430                    - state.parameters_.max_slope_), 0.0)
 431     * state.parameters_.max_slope_factor_;
 432
 433   if (sign (dy) == 0
 434       && sign (slur_dy) != 0
 435       && !state.is_broken_)
 436     demerit += state.parameters_.non_horizontal_penalty_;
 437
 438   if (sign (dy)
 439       && !state.is_broken_
 440       && sign (slur_dy)
 441       && sign (slur_dy) != sign (dy))
 442     demerit += state.edge_has_beams_
 443       ? state.parameters_.same_slope_penalty_ / 10
 444       : state.parameters_.same_slope_penalty_;
 445
 446 #if DEBUG_SLUR_SCORING
 447   score_card_ += to_string ("S%.2f", demerit);
 448 #endif
 449   score_ += demerit;
 450 }
 451
 452 void
 453 Slur_configuration::score (Slur_score_state const &state)
 454 {
 455   score_extra_encompass (state);
 456   score_slopes (state);
 457   score_edges (state);
 458   score_encompass (state);
 459 }