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 const round = my_round (p);
  53       Real const frac = p - round;
  54       if (fabs (frac) < 4 * state.thickness_
  55           && Staff_symbol_referencer::on_staff_line (staff, int (round)))
  56         {
  57           Direction resolution_dir = frac ? state.dir_ : CENTER;
  58
  59           // TODO: parameter
  60           Real newp = round + resolution_dir * 5 * state.thickness_;
  61
  62           Real dy = (newp - p) * state.staff_space_ / 2.0;
  63
  64           bez.control_[1][Y_AXIS] += dy;
  65           bez.control_[2][Y_AXIS] += dy;
  66         }
  67     }
  68   return bez;
  69 }
  70
  71 Real
  72 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
  73             Bezier curve, Direction d, vector<Offset> const &avoid)
  74 {
  75   Real fit_factor = 0.0;
  76   Offset x0 = curve.control_[0];
  77   curve.translate (-x0);
  78   curve.rotate (-dz_unit.arg ());
  79   curve.scale (1, d);
  80
  81   Interval curve_xext;
  82   curve_xext.add_point (curve.control_[0][X_AXIS]);
  83   curve_xext.add_point (curve.control_[3][X_AXIS]);
  84
  85   for (vsize i = 0; i < avoid.size (); i++)
  86     {
  87       Offset z = (avoid[i] - x0);
  88       Offset p (dot_product (z, dz_unit),
  89                 d * dot_product (z, dz_perp));
  90
  91       bool close_to_edge = false;
  92       for (LEFT_and_RIGHT (d))
  93         close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
  94
  95       if (close_to_edge)
  96         continue;
  97
  98       Real eps = 0.01;
  99       Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
 100       pext.intersect (curve_xext);
 101
 102       if (pext.is_empty () || pext.length () <= 1.999 * eps)
 103         continue;
 104
 105       Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
 106       if (y)
 107         fit_factor = max (fit_factor, (p[Y_AXIS] / y));
 108     }
 109   return fit_factor;
 110 }
 111
 112 void
 113 Slur_configuration::generate_curve (Slur_score_state const &state,
 114                                     Real r_0, Real h_inf,
 115                                     vector<Offset> const &avoid)
 116 {
 117   Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
 118   Offset dz_unit = dz;
 119   dz_unit *= 1 / dz.length ();
 120   Offset dz_perp = dz_unit * Offset (0, 1);
 121
 122   Real indent, height;
 123   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
 124
 125   Real len = dz.length ();
 126
 127   /* This condition,
 128
 129   len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
 130
 131   is equivalent to:
 132
 133   |bez' (0)| < | bez' (.5)|
 134
 135   when (control2 - control1) has the same direction as
 136   (control3 - control0).  */
 137
 138   Real max_indent = len / 3.1;
 139   indent = min (indent, max_indent);
 140
 141   Real a1 = sqr (len) / 3.0;
 142   Real a2 = 0.75 * sqr (indent + len / 3.0);
 143   Real max_h = a1 - a2;
 144
 145   if (max_h < 0)
 146     {
 147       programming_error ("slur indent too small");
 148       max_h = len / 3.0;
 149     }
 150   else
 151     max_h = sqrt (max_h);
 152
 153   Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
 154
 155   Real x1 = (eccentricity + indent);
 156   Real x2 = (eccentricity - indent);
 157
 158   Bezier curve;
 159   curve.control_[0] = attachment_[LEFT];
 160   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 161                       + dz_unit * x1;
 162   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 163                       + dz_unit * x2;
 164   curve.control_[3] = attachment_[RIGHT];
 165
 166   Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
 167                         curve, state.dir_, avoid);
 168
 169   height = max (height, min (height * ff, max_h));
 170
 171   curve.control_[0] = attachment_[LEFT];
 172   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 173                       + dz_unit * x1;
 174   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 175                       + dz_unit * x2;
 176   curve.control_[3] = attachment_[RIGHT];
 177
 178   curve_ = avoid_staff_line (state, curve);
 179   height_ = height;
 180 }
 181
 182 Slur_configuration::Slur_configuration ()
 183 {
 184   score_ = 0.0;
 185   index_ = -1;
 186 };
 187
 188 void
 189 Slur_configuration::add_score (Real s, string desc)
 190 {
 191   if (s < 0)
 192     {
 193       programming_error ("Negative demerits found for slur. Ignoring");
 194       s = 0.0;
 195     }
 196
 197   if (s)
 198     {
 199       if (score_card_.length () > 0)
 200         score_card_ += ", ";
 201       score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
 202       score_ += s;
 203     }
 204 }
 205
 206 void
 207 Slur_configuration::score_encompass (Slur_score_state const &state)
 208 {
 209   Bezier const &bez (curve_);
 210   Real demerit = 0.0;
 211
 212   /*
 213     Distances for heads that are between slur and line between
 214     attachment points.
 215   */
 216   vector<Real> convex_head_distances;
 217   for (vsize j = 0; j < state.encompass_infos_.size (); j++)
 218     {
 219       Real x = state.encompass_infos_[j].x_;
 220
 221       bool l_edge = j == 0;
 222       bool r_edge = j == state.encompass_infos_.size () - 1;
 223       bool edge = l_edge || r_edge;
 224
 225       if (! (x < attachment_[RIGHT][X_AXIS]
 226              && x > attachment_[LEFT][X_AXIS]))
 227         continue;
 228
 229       Real y = bez.get_other_coordinate (X_AXIS, x);
 230       if (!edge)
 231         {
 232           Real head_dy = (y - state.encompass_infos_[j].head_);
 233           if (state.dir_ * head_dy < 0)
 234             {
 235               demerit += state.parameters_.head_encompass_penalty_;
 236               convex_head_distances.push_back (0.0);
 237             }
 238           else
 239             {
 240               Real hd = (head_dy)
 241                         ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 242                         : state.parameters_.head_encompass_penalty_;
 243               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
 244
 245               demerit += hd;
 246             }
 247
 248           Real line_y = linear_interpolate (x,
 249                                             attachment_[RIGHT][X_AXIS],
 250                                             attachment_[LEFT][X_AXIS],
 251                                             attachment_[RIGHT][Y_AXIS],
 252                                             attachment_[LEFT][Y_AXIS]);
 253
 254           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 255             {
 256
 257               Real closest
 258                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
 259               Real d = fabs (closest - y);
 260
 261               convex_head_distances.push_back (d);
 262             }
 263         }
 264
 265       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 266         {
 267           Real stem_dem = state.parameters_.stem_encompass_penalty_;
 268           if ((l_edge && state.dir_ == UP)
 269               || (r_edge && state.dir_ == DOWN))
 270             stem_dem /= 5;
 271
 272           demerit += stem_dem;
 273         }
 274     }
 275   add_score (demerit, "encompass");
 276
 277   if (vsize n = convex_head_distances.size ())
 278     {
 279       Real avg_distance = 0.0;
 280       Real min_dist = infinity_f;
 281
 282       for (vsize j = 0; j < n; j++)
 283         {
 284           min_dist = min (min_dist, convex_head_distances[j]);
 285           avg_distance += convex_head_distances[j];
 286         }
 287
 288       /*
 289         For slurs over 3 or 4 heads, the average distance is not a
 290         good normalizer.
 291       */
 292       if (n <= 2)
 293         {
 294           Real fact = 1.0;
 295           avg_distance += height_ * fact;
 296           ++n;
 297         }
 298
 299       /*
 300         TODO: maybe it's better to use (avgdist - mindist)*factor
 301         as penalty.
 302       */
 303       avg_distance /= n;
 304       Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 305       if (min_dist > 0.0)
 306         variance_penalty
 307           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
 308
 309       variance_penalty = max (variance_penalty, 0.0);
 310       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 311
 312       add_score (variance_penalty, "variance");
 313     }
 314 }
 315
 316 void
 317 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 318 {
 319   for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
 320     {
 321       Drul_array<Offset> attachment = attachment_;
 322       Extra_collision_info const &info (state.extra_encompass_infos_[j]);
 323
 324       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 325
 326       /*
 327         to prevent numerical inaccuracies in
 328         Bezier::get_other_coordinate ().
 329       */
 330
 331       bool found = false;
 332       Real y = 0.0;
 333
 334       for (LEFT_and_RIGHT (d))
 335         {
 336           /*
 337             We need to check for the bound explicitly, since the
 338             slur-ending can be almost vertical, making the Y
 339             coordinate a bad approximation of the object-slur
 340             distance.
 341           */
 342           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
 343           if (!as_item)
 344             continue;
 345
 346           Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
 347           item_x.intersect (state.extremes_[d].slur_head_x_extent_);
 348           if (!item_x.is_empty ())
 349             {
 350               y = attachment[d][Y_AXIS];
 351               found = true;
 352             }
 353
 354         }
 355
 356       if (!found)
 357         {
 358           Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
 359
 360           if (!slur_wid.contains (x))
 361             continue;
 362
 363           y = curve_.get_other_coordinate (X_AXIS, x);
 364         }
 365
 366       Real dist = 0.0;
 367       if (info.type_ == ly_symbol2scm ("around"))
 368         dist = info.extents_[Y_AXIS].distance (y);
 369
 370       /*
 371         Have to score too: the curve enumeration is limited in its
 372         shape, and may produce curves which collide anyway.
 373        */
 374       else if (info.type_ == ly_symbol2scm ("inside"))
 375         dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
 376       else
 377         programming_error ("unknown avoidance type");
 378
 379       dist = max (dist, 0.0);
 380
 381       Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
 382                                                   state.parameters_.extra_encompass_free_distance_,
 383                                                   dist);
 384
 385       add_score (penalty, "extra");
 386     }
 387 }
 388
 389 void
 390 Slur_configuration::score_edges (Slur_score_state const &state)
 391 {
 392
 393   Offset dz = attachment_[RIGHT]
 394               - attachment_[LEFT];
 395   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 396   for (LEFT_and_RIGHT (d))
 397     {
 398       Real y = attachment_[d][Y_AXIS];
 399       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 400
 401       Real factor = state.parameters_.edge_attraction_factor_;
 402       Real demerit = factor * dy;
 403       if (state.extremes_[d].stem_
 404           && state.extremes_[d].stem_dir_ == state.dir_
 405           // TODO - Stem::get_beaming() should be precomputed.
 406           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
 407         demerit /= 5;
 408
 409       demerit *= exp (state.dir_ * d * slope
 410                       * state.parameters_.edge_slope_exponent_);
 411
 412       string dir_str = d == LEFT ? "L" : "R";
 413       add_score (demerit, dir_str + " edge");
 414     }
 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 // This is a temporary hack to see how much we can gain by using a
 459 // priority queue on the beams to score.
 460 static int score_count = 0;
 461 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
 462            (),
 463            "count number of slur scores.")
 464 {
 465   return scm_from_int (score_count);
 466 }
 467
 468 void
 469 Slur_configuration::run_next_scorer (Slur_score_state const &state)
 470 {
 471   switch (next_scorer_todo)
 472     {
 473     case EXTRA_ENCOMPASS:
 474       score_extra_encompass (state);
 475       break;
 476     case SLOPE:
 477       score_slopes (state);
 478       break;
 479     case EDGES:
 480       score_edges (state);
 481       break;
 482     case ENCOMPASS:
 483       score_encompass (state);
 484       break;
 485     default:
 486       assert (false);
 487     }
 488   next_scorer_todo++;
 489   score_count++;
 490 }
 491
 492 bool
 493 Slur_configuration::done () const
 494 {
 495   return next_scorer_todo >= NUM_SCORERS;
 496 }
 497
 498 Slur_configuration *
 499 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
 500 {
 501   Slur_configuration *conf = new Slur_configuration;
 502   conf->attachment_ = offs;
 503   conf->index_ = idx;
 504   conf->next_scorer_todo = INITIAL_SCORE + 1;
 505   return conf;
 506 }