lily/slur-configuration.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "slur-configuration.hh"
  21
  22 #include "item.hh"
  23 #include "libc-extension.hh"
  24 #include "misc.hh"
  25 #include "pointer-group-interface.hh"
  26 #include "slur-scoring.hh"
  27 #include "slur.hh"
  28 #include "spanner.hh"
  29 #include "staff-symbol-referencer.hh"
  30 #include "stem.hh"
  31 #include "warn.hh"
  32
  33 Bezier
  34 avoid_staff_line (Slur_score_state const &state,
  35                   Bezier bez)
  36 {
  37   Offset horiz (1, 0);
  38   vector<Real> ts = bez.solve_derivative (horiz);
  39
  40   /* TODO: handle case of broken slur.  */
  41   if (!ts.empty ()
  42       && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
  43       && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
  44     {
  45       Real y = bez.curve_point (ts[0])[Y_AXIS];
  46
  47       Grob *staff = state.extremes_[LEFT].staff_;
  48
  49       Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
  50                / state.staff_space_;
  51
  52       Real distance = fabs (my_round (p) - p);  //  in halfspaces
  53       if (distance < 4 * state.thickness_
  54           && (int) fabs (my_round (p))
  55           <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
  56           && (int (fabs (my_round (p))) % 2
  57               != Staff_symbol_referencer::line_count (staff) % 2))
  58         {
  59           Direction resolution_dir
  60             = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
  61
  62           // TODO: parameter
  63           Real newp = my_round (p) + resolution_dir
  64                       * 5 * state.thickness_;
  65
  66           Real dy = (newp - p) * state.staff_space_ / 2.0;
  67
  68           bez.control_[1][Y_AXIS] += dy;
  69           bez.control_[2][Y_AXIS] += dy;
  70         }
  71     }
  72   return bez;
  73 }
  74
  75 Real
  76 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
  77             Bezier curve, Direction d, vector<Offset> const &avoid)
  78 {
  79   Real fit_factor = 0.0;
  80   Offset x0 = curve.control_[0];
  81   curve.translate (-x0);
  82   curve.rotate (-dz_unit.arg ());
  83   curve.scale (1, d);
  84
  85   Interval curve_xext;
  86   curve_xext.add_point (curve.control_[0][X_AXIS]);
  87   curve_xext.add_point (curve.control_[3][X_AXIS]);
  88
  89   for (vsize i = 0; i < avoid.size (); i++)
  90     {
  91       Offset z = (avoid[i] - x0);
  92       Offset p (dot_product (z, dz_unit),
  93                 d * dot_product (z, dz_perp));
  94
  95       bool close_to_edge = false;
  96       for (LEFT_and_RIGHT (d))
  97         close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
  98
  99       if (close_to_edge)
 100         continue;
 101
 102       Real eps = 0.01;
 103       Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
 104       pext.intersect (curve_xext);
 105
 106       if (pext.is_empty () || pext.length () <= 1.999 * eps)
 107         continue;
 108
 109       Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
 110       if (y)
 111         fit_factor = max (fit_factor, (p[Y_AXIS] / y));
 112     }
 113   return fit_factor;
 114 }
 115
 116 void
 117 Slur_configuration::generate_curve (Slur_score_state const &state,
 118                                     Real r_0, Real h_inf,
 119                                     vector<Offset> const &avoid)
 120 {
 121   Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
 122   Offset dz_unit = dz;
 123   dz_unit *= 1 / dz.length ();
 124   Offset dz_perp = dz_unit * Offset (0, 1);
 125
 126   Real indent, height;
 127   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
 128
 129   Real len = dz.length ();
 130
 131   /* This condition,
 132
 133   len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
 134
 135   is equivalent to:
 136
 137   |bez' (0)| < | bez' (.5)|
 138
 139   when (control2 - control1) has the same direction as
 140   (control3 - control0).  */
 141
 142   Real max_indent = len / 3.1;
 143   indent = min (indent, max_indent);
 144
 145   Real a1 = sqr (len) / 3.0;
 146   Real a2 = 0.75 * sqr (indent + len / 3.0);
 147   Real max_h = a1 - a2;
 148
 149   if (max_h < 0)
 150     {
 151       programming_error ("slur indent too small");
 152       max_h = len / 3.0;
 153     }
 154   else
 155     max_h = sqrt (max_h);
 156
 157   Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
 158
 159   Real x1 = (eccentricity + indent);
 160   Real x2 = (eccentricity - indent);
 161
 162   Bezier curve;
 163   curve.control_[0] = attachment_[LEFT];
 164   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 165                       + dz_unit * x1;
 166   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 167                       + dz_unit * x2;
 168   curve.control_[3] = attachment_[RIGHT];
 169
 170   Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
 171                         curve, state.dir_, avoid);
 172
 173   height = max (height, min (height * ff, max_h));
 174
 175   curve.control_[0] = attachment_[LEFT];
 176   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 177                       + dz_unit * x1;
 178   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 179                       + dz_unit * x2;
 180   curve.control_[3] = attachment_[RIGHT];
 181
 182   curve_ = avoid_staff_line (state, curve);
 183   height_ = height;
 184 }
 185
 186 Slur_configuration::Slur_configuration ()
 187 {
 188   score_ = 0.0;
 189   index_ = -1;
 190 };
 191
 192 void
 193 Slur_configuration::add_score (Real s, string desc)
 194 {
 195   if (s < 0)
 196     {
 197       programming_error ("Negative demerits found for slur. Ignoring");
 198       s = 0.0;
 199     }
 200
 201   if (s)
 202     {
 203       if (score_card_.length () > 0)
 204         score_card_ += ", ";
 205       score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
 206       score_ += s;
 207     }
 208 }
 209
 210 void
 211 Slur_configuration::score_encompass (Slur_score_state const &state)
 212 {
 213   Bezier const &bez (curve_);
 214   Real demerit = 0.0;
 215
 216   /*
 217     Distances for heads that are between slur and line between
 218     attachment points.
 219   */
 220   vector<Real> convex_head_distances;
 221   for (vsize j = 0; j < state.encompass_infos_.size (); j++)
 222     {
 223       Real x = state.encompass_infos_[j].x_;
 224
 225       bool l_edge = j == 0;
 226       bool r_edge = j == state.encompass_infos_.size () - 1;
 227       bool edge = l_edge || r_edge;
 228
 229       if (! (x < attachment_[RIGHT][X_AXIS]
 230              && x > attachment_[LEFT][X_AXIS]))
 231         continue;
 232
 233       Real y = bez.get_other_coordinate (X_AXIS, x);
 234       if (!edge)
 235         {
 236           Real head_dy = (y - state.encompass_infos_[j].head_);
 237           if (state.dir_ * head_dy < 0)
 238             {
 239               demerit += state.parameters_.head_encompass_penalty_;
 240               convex_head_distances.push_back (0.0);
 241             }
 242           else
 243             {
 244               Real hd = (head_dy)
 245                         ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 246                         : state.parameters_.head_encompass_penalty_;
 247               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
 248
 249               demerit += hd;
 250             }
 251
 252           Real line_y = linear_interpolate (x,
 253                                             attachment_[RIGHT][X_AXIS],
 254                                             attachment_[LEFT][X_AXIS],
 255                                             attachment_[RIGHT][Y_AXIS],
 256                                             attachment_[LEFT][Y_AXIS]);
 257
 258           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 259             {
 260
 261               Real closest
 262                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
 263               Real d = fabs (closest - y);
 264
 265               convex_head_distances.push_back (d);
 266             }
 267         }
 268
 269       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 270         {
 271           Real stem_dem = state.parameters_.stem_encompass_penalty_;
 272           if ((l_edge && state.dir_ == UP)
 273               || (r_edge && state.dir_ == DOWN))
 274             stem_dem /= 5;
 275
 276           demerit += stem_dem;
 277         }
 278     }
 279   add_score (demerit, "encompass");
 280
 281   if (convex_head_distances.size ())
 282     {
 283       Real avg_distance = 0.0;
 284       Real min_dist = infinity_f;
 285       for (vsize j = 0; j < convex_head_distances.size (); j++)
 286         {
 287           min_dist = min (min_dist, convex_head_distances[j]);
 288           avg_distance += convex_head_distances[j];
 289         }
 290
 291       /*
 292         For slurs over 3 or 4 heads, the average distance is not a
 293         good normalizer.
 294       */
 295       Real n = convex_head_distances.size ();
 296       if (n <= 2)
 297         {
 298           Real fact = 1.0;
 299           avg_distance += height_ * fact;
 300           n += fact;
 301         }
 302
 303       /*
 304         TODO: maybe it's better to use (avgdist - mindist)*factor
 305         as penalty.
 306       */
 307       avg_distance /= n;
 308       Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 309       if (min_dist > 0.0)
 310         variance_penalty
 311           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
 312
 313       variance_penalty = max (variance_penalty, 0.0);
 314       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 315
 316       add_score (variance_penalty, "variance");
 317     }
 318 }
 319
 320 void
 321 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 322 {
 323   for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
 324     {
 325       Drul_array<Offset> attachment = attachment_;
 326       Extra_collision_info const &info (state.extra_encompass_infos_[j]);
 327
 328       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 329
 330       /*
 331         to prevent numerical inaccuracies in
 332         Bezier::get_other_coordinate ().
 333       */
 334
 335       bool found = false;
 336       Real y = 0.0;
 337
 338       for (LEFT_and_RIGHT (d))
 339         {
 340           /*
 341             We need to check for the bound explicitly, since the
 342             slur-ending can be almost vertical, making the Y
 343             coordinate a bad approximation of the object-slur
 344             distance.
 345           */
 346           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
 347           if (!as_item)
 348             continue;
 349
 350           Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
 351           item_x.intersect (state.extremes_[d].slur_head_x_extent_);
 352           if (!item_x.is_empty ())
 353             {
 354               y = attachment[d][Y_AXIS];
 355               found = true;
 356             }
 357
 358         }
 359
 360       if (!found)
 361         {
 362           Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
 363
 364           if (!slur_wid.contains (x))
 365             continue;
 366
 367           y = curve_.get_other_coordinate (X_AXIS, x);
 368         }
 369
 370       Real dist = 0.0;
 371       if (info.type_ == ly_symbol2scm ("around"))
 372         dist = info.extents_[Y_AXIS].distance (y);
 373
 374       /*
 375         Have to score too: the curve enumeration is limited in its
 376         shape, and may produce curves which collide anyway.
 377        */
 378       else if (info.type_ == ly_symbol2scm ("inside"))
 379         dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
 380       else
 381         programming_error ("unknown avoidance type");
 382
 383       dist = max (dist, 0.0);
 384
 385       Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
 386                                                   state.parameters_.extra_encompass_free_distance_,
 387                                                   dist);
 388
 389       add_score (penalty, "extra");
 390     }
 391 }
 392
 393 void
 394 Slur_configuration::score_edges (Slur_score_state const &state)
 395 {
 396
 397   Offset dz = attachment_[RIGHT]
 398               - attachment_[LEFT];
 399   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 400   for (LEFT_and_RIGHT (d))
 401     {
 402       Real y = attachment_[d][Y_AXIS];
 403       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 404
 405       Real factor = state.parameters_.edge_attraction_factor_;
 406       Real demerit = factor * dy;
 407       if (state.extremes_[d].stem_
 408           && state.extremes_[d].stem_dir_ == state.dir_
 409           // TODO - Stem::get_beaming() should be precomputed.
 410           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
 411         demerit /= 5;
 412
 413       demerit *= exp (state.dir_ * d * slope
 414                       * state.parameters_.edge_slope_exponent_);
 415
 416       string dir_str = d == LEFT ? "L" : "R";
 417       add_score (demerit, dir_str + " edge");
 418     }
 419 }
 420
 421 void
 422 Slur_configuration::score_slopes (Slur_score_state const &state)
 423 {
 424   Real dy = state.musical_dy_;
 425   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
 426   Real slur_dy = slur_dz[Y_AXIS];
 427   Real demerit = 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   /* 0.2: account for staffline offset. */
 434   Real max_dy = (fabs (dy) + 0.2);
 435   if (state.edge_has_beams_)
 436     max_dy += 1.0;
 437
 438   if (!state.is_broken_)
 439     demerit += state.parameters_.steeper_slope_factor_
 440                * (max (fabs (slur_dy) - max_dy, 0.0));
 441
 442   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 443                    - state.parameters_.max_slope_), 0.0)
 444              * state.parameters_.max_slope_factor_;
 445
 446   if (sign (dy) == 0
 447       && sign (slur_dy) != 0
 448       && !state.is_broken_)
 449     demerit += state.parameters_.non_horizontal_penalty_;
 450
 451   if (sign (dy)
 452       && !state.is_broken_
 453       && sign (slur_dy)
 454       && sign (slur_dy) != sign (dy))
 455     demerit += state.edge_has_beams_
 456                ? state.parameters_.same_slope_penalty_ / 10
 457                : state.parameters_.same_slope_penalty_;
 458
 459   add_score (demerit, "slope");
 460 }
 461
 462 // This is a temporary hack to see how much we can gain by using a
 463 // priority queue on the beams to score.
 464 static int score_count = 0;
 465 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
 466            (),
 467            "count number of slur scores.")
 468 {
 469   return scm_from_int (score_count);
 470 }
 471
 472 void
 473 Slur_configuration::run_next_scorer (Slur_score_state const &state)
 474 {
 475   switch (next_scorer_todo)
 476     {
 477     case EXTRA_ENCOMPASS:
 478       score_extra_encompass (state);
 479       break;
 480     case SLOPE:
 481       score_slopes (state);
 482       break;
 483     case EDGES:
 484       score_edges (state);
 485       break;
 486     case ENCOMPASS:
 487       score_encompass (state);
 488       break;
 489     default:
 490       assert (false);
 491     }
 492   next_scorer_todo++;
 493   score_count++;
 494 }
 495
 496 bool
 497 Slur_configuration::done () const
 498 {
 499   return next_scorer_todo >= NUM_SCORERS;
 500 }
 501
 502 Slur_configuration *
 503 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
 504 {
 505   Slur_configuration *conf = new Slur_configuration;
 506   conf->attachment_ = offs;
 507   conf->index_ = idx;
 508   conf->next_scorer_todo = INITIAL_SCORE + 1;
 509   return conf;
 510 }