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