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--2006 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   vector<Real> ts = bez.solve_derivative (horiz);
  29
  30   /* TODO: handle case of broken slur.  */
  31   if (!ts.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, vector<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 (vsize 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 () <= 1.999 * 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                                     vector<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
 174 void
 175 Slur_configuration::add_score (Real s, string desc)
 176 {
 177   if (s < 0)
 178     {
 179       programming_error ("Negative demerits found for slur. Ignoring");
 180       s = 0.0;
 181     }
 182
 183   if (s)
 184     {
 185       score_card_ += to_string ("%s=%.2f ", desc.c_str (), s);
 186       score_ += s;
 187     }
 188 }
 189
 190 void
 191 Slur_configuration::score_encompass (Slur_score_state const &state)
 192 {
 193   Bezier const &bez (curve_);
 194   Real demerit = 0.0;
 195
 196   /*
 197     Distances for heads that are between slur and line between
 198     attachment points.
 199   */
 200   vector<Real> convex_head_distances;
 201   for (vsize j = 0; j < state.encompass_infos_.size (); j++)
 202     {
 203       Real x = state.encompass_infos_[j].x_;
 204
 205       bool l_edge = j == 0;
 206       bool r_edge = j == state.encompass_infos_.size () - 1;
 207       bool edge = l_edge || r_edge;
 208
 209       if (! (x < attachment_[RIGHT][X_AXIS]
 210              && x > attachment_[LEFT][X_AXIS]))
 211         continue;
 212
 213       Real y = bez.get_other_coordinate (X_AXIS, x);
 214       if (!edge)
 215         {
 216           Real head_dy = (y - state.encompass_infos_[j].head_);
 217           if (state.dir_ * head_dy < 0)
 218             {
 219               demerit += state.parameters_.head_encompass_penalty_;
 220               convex_head_distances.push_back (0.0);
 221             }
 222           else
 223             {
 224               Real hd = (head_dy)
 225                 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 226                 : state.parameters_.head_encompass_penalty_;
 227               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
 228
 229               demerit += hd;
 230             }
 231
 232           Real line_y = linear_interpolate (x,
 233                                             attachment_[RIGHT][X_AXIS],
 234                                             attachment_[LEFT][X_AXIS],
 235                                             attachment_[RIGHT][Y_AXIS],
 236                                             attachment_[LEFT][Y_AXIS]);
 237
 238           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 239             {
 240
 241               Real closest
 242                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
 243               Real d = fabs (closest - y);
 244
 245               convex_head_distances.push_back (d);
 246             }
 247         }
 248
 249       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 250         {
 251           Real stem_dem = state.parameters_.stem_encompass_penalty_;
 252           if ((l_edge && state.dir_ == UP)
 253               || (r_edge && state.dir_ == DOWN))
 254             stem_dem /= 5;
 255
 256           demerit += stem_dem;
 257         }
 258       else if (!edge)
 259         {
 260           Interval ext;
 261           ext.add_point (state.encompass_infos_[j].stem_);
 262           ext.add_point (state.encompass_infos_[j].head_);
 263
 264           // ?
 265           demerit += -state.parameters_.closeness_factor_
 266             * min (state.dir_
 267                    * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
 268             / state.encompass_infos_.size ();
 269         }
 270     }
 271   add_score (demerit, "encompass");
 272
 273   if (convex_head_distances.size ())
 274     {
 275       Real avg_distance = 0.0;
 276       Real min_dist = infinity_f;
 277       for (vsize j = 0; j < convex_head_distances.size (); j++)
 278         {
 279           min_dist = min (min_dist, convex_head_distances[j]);
 280           avg_distance += convex_head_distances[j];
 281         }
 282
 283       /*
 284         For slurs over 3 or 4 heads, the average distance is not a
 285         good normalizer.
 286       */
 287       Real n = convex_head_distances.size ();
 288       if (n <= 2)
 289         {
 290           Real fact = 1.0;
 291           avg_distance += height_ * fact;
 292           n += fact;
 293         }
 294
 295       /*
 296         TODO: maybe it's better to use (avgdist - mindist)*factor
 297         as penalty.
 298       */
 299       avg_distance /= n;
 300       Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 301       if (min_dist > 0.0)
 302         variance_penalty
 303           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
 304
 305       variance_penalty = max (variance_penalty, 0.0);
 306       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 307
 308       add_score (variance_penalty, "variance");
 309     }
 310 }
 311
 312 void
 313 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 314 {
 315   for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
 316     {
 317       Drul_array<Offset> attachment = attachment_;
 318       Extra_collision_info const &info (state.extra_encompass_infos_[j]);
 319
 320       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 321
 322       /*
 323         to prevent numerical inaccuracies in
 324         Bezier::get_other_coordinate ().
 325       */
 326       Direction d = LEFT;
 327       bool found = false;
 328       Real y = 0.0;
 329
 330       do
 331         {
 332           /*
 333             We need to check for the bound explicitly, since the
 334             slur-ending can be almost vertical, making the Y
 335             coordinate a bad approximation of the object-slur
 336             distance.
 337           */
 338           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
 339           if (!as_item)
 340             continue;
 341
 342           Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
 343           item_x.intersect (state.extremes_[d].slur_head_x_extent_);
 344           if (!item_x.is_empty ())
 345             {
 346               y = attachment[d][Y_AXIS];
 347               found = true;
 348             }
 349
 350         }
 351       while (flip (&d) != LEFT);
 352
 353       if (!found)
 354         {
 355           Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
 356
 357           if (!slur_wid.contains (x))
 358             continue;
 359
 360           y = curve_.get_other_coordinate (X_AXIS, x);
 361         }
 362
 363       Real dist = 0.0;
 364       if (info.type_ == ly_symbol2scm ("around"))
 365         dist = info.extents_[Y_AXIS].distance (y);
 366
 367       /*
 368         Have to score too: the curve enumeration is limited in its
 369         shape, and may produce curves which collide anyway.
 370        */
 371       else if (info.type_ == ly_symbol2scm ("inside"))
 372         dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
 373       else
 374         programming_error ("unknown avoidance type");
 375
 376       dist = max (dist, 0.0);
 377
 378       Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
 379                                                   state.parameters_.extra_encompass_free_distance_,
 380                                                   dist);
 381
 382       add_score (penalty, "extra");
 383     }
 384 }
 385
 386 void
 387 Slur_configuration::score_edges (Slur_score_state const &state)
 388 {
 389   Direction d = LEFT;
 390   Offset dz = attachment_[RIGHT]
 391     - attachment_[LEFT];
 392   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 393   do
 394     {
 395       Real y = attachment_[d][Y_AXIS];
 396       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 397
 398       Real factor = state.parameters_.edge_attraction_factor_;
 399       Real demerit = factor * dy;
 400       if (state.extremes_[d].stem_
 401           && state.extremes_[d].stem_dir_ == state.dir_
 402           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
 403         demerit /= 5;
 404
 405       demerit *= exp (state.dir_ * d * slope
 406                       * state.parameters_.edge_slope_exponent_);
 407
 408       add_score (demerit, "edge");
 409     }
 410   while (flip (&d) != LEFT);
 411 }
 412
 413 void
 414 Slur_configuration ::score_slopes (Slur_score_state const &state)
 415 {
 416   Real dy = state.musical_dy_;
 417   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
 418   Real slur_dy = slur_dz[Y_AXIS];
 419   Real demerit = 0.0;
 420
 421   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 422                    - state.parameters_.max_slope_), 0.0)
 423     * state.parameters_.max_slope_factor_;
 424
 425   /* 0.2: account for staffline offset. */
 426   Real max_dy = (fabs (dy) + 0.2);
 427   if (state.edge_has_beams_)
 428     max_dy += 1.0;
 429
 430   if (!state.is_broken_)
 431     demerit += state.parameters_.steeper_slope_factor_
 432       * (max (fabs (slur_dy) -max_dy, 0.0));
 433
 434   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 435                    - state.parameters_.max_slope_), 0.0)
 436     * state.parameters_.max_slope_factor_;
 437
 438   if (sign (dy) == 0
 439       && sign (slur_dy) != 0
 440       && !state.is_broken_)
 441     demerit += state.parameters_.non_horizontal_penalty_;
 442
 443   if (sign (dy)
 444       && !state.is_broken_
 445       && sign (slur_dy)
 446       && sign (slur_dy) != sign (dy))
 447     demerit += state.edge_has_beams_
 448       ? state.parameters_.same_slope_penalty_ / 10
 449       : state.parameters_.same_slope_penalty_;
 450
 451   add_score (demerit, "slope");
 452 }
 453
 454 void
 455 Slur_configuration::calculate_score (Slur_score_state const &state)
 456 {
 457   score_extra_encompass (state);
 458   score_slopes (state);
 459   score_edges (state);
 460   score_encompass (state);
 461 }