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