lily/slur-configuration.cc

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