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