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