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