lily/slur-configuration.cc

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