lily/slur-configuration.cc

   1 /*
   2   slur-configuration.cc -- implement Slur_configuration
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "slur-configuration.hh"
  10
  11 #include <math.h>
  12
  13 #include "stem.hh"
  14 #include "warn.hh"
  15 #include "misc.hh"
  16 #include "item.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "slur.hh"
  19 #include "slur-scoring.hh"
  20 #include "spanner.hh"
  21 #include "staff-symbol-referencer.hh"
  22 #include "libc-extension.hh"
  23
  24 Bezier
  25 avoid_staff_line (Slur_score_state const &state,
  26                   Bezier bez)
  27 {
  28   Offset horiz (1, 0);
  29   Array<Real> ts = bez.solve_derivative (horiz);
  30
  31   /* TODO: handle case of broken slur.  */
  32   if (!ts.is_empty ()
  33       && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
  34       && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
  35     {
  36       Real y = bez.curve_point (ts[0])[Y_AXIS];
  37
  38       Grob *staff = state.extremes_[LEFT].staff_;
  39
  40       Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
  41         / state.staff_space_;
  42
  43       Real distance = fabs (my_round (p) - p);  //  in halfspaces
  44       if (distance < 4 * state.thickness_
  45           && (int) fabs (my_round (p))
  46           <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
  47           && (int (fabs (my_round (p))) % 2
  48               != Staff_symbol_referencer::line_count (staff) % 2))
  49         {
  50           Direction resolution_dir
  51             = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
  52
  53           // TODO: parameter
  54           Real newp = my_round (p) + resolution_dir
  55             * 5 * state.thickness_;
  56
  57           Real dy = (newp - p) * state.staff_space_ / 2.0;
  58
  59           bez.control_[1][Y_AXIS] += dy;
  60           bez.control_[2][Y_AXIS] += dy;
  61         }
  62     }
  63   return bez;
  64 }
  65
  66 Real
  67 fit_factor (Offset dz_unit, Offset dz_perp,
  68             Bezier curve, Direction d, Array<Offset> const &avoid)
  69 {
  70   Real fit_factor = 0.0;
  71   Offset x0 = curve.control_[0];
  72   curve.translate (-x0);
  73   curve.rotate (-dz_unit.arg ());
  74   curve.scale (1, d);
  75
  76   Interval curve_xext;
  77   curve_xext.add_point (curve.control_[0][X_AXIS]);
  78   curve_xext.add_point (curve.control_[3][X_AXIS]);
  79
  80   for (int i = 0; i < avoid.size (); i++)
  81     {
  82       Offset z = (avoid[i] - x0);
  83       Offset p (dot_product (z, dz_unit),
  84                 d * dot_product (z, dz_perp));
  85       if (!curve_xext.contains (p[X_AXIS]))
  86         continue;
  87
  88       Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
  89       if (y)
  90         fit_factor = max (fit_factor, (p[Y_AXIS] / y));
  91     }
  92   return fit_factor;
  93 }
  94
  95 void
  96 Slur_configuration::generate_curve (Slur_score_state const &state,
  97                                     Real r_0, Real h_inf,
  98                                     Array<Offset> const &avoid)
  99 {
 100   Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
 101   Offset dz_unit = dz;
 102   dz_unit *= 1 / dz.length ();
 103   Offset dz_perp = dz_unit * Offset (0, 1);
 104
 105   Real indent, height;
 106   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
 107
 108   Real len = dz.length ();
 109
 110   /* This condition,
 111
 112   len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
 113
 114   is equivalent to:
 115
 116   |bez' (0)| < | bez' (.5)|
 117
 118   when (control2 - control1) has the same direction as
 119   (control3 - control0).  */
 120
 121   Real max_indent = len / 3.1;
 122   indent = min (indent, max_indent);
 123
 124   Real a1 = sqr (len) / 3.0;
 125   Real a2 = 0.75 * sqr (indent + len / 3.0);
 126   Real max_h = a1 - a2;
 127
 128   if (max_h < 0)
 129     {
 130       programming_error ("slur indent too small");
 131       max_h = len / 3.0;
 132     }
 133   else
 134     max_h = sqrt (max_h);
 135
 136   Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
 137
 138   Real x1 = (eccentricity + indent);
 139   Real x2 = (eccentricity - indent);
 140
 141   Bezier curve;
 142   curve.control_[0] = attachment_[LEFT];
 143   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 144     + dz_unit * x1;
 145   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 146     + dz_unit * x2;
 147   curve.control_[3] = attachment_[RIGHT];
 148
 149   Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
 150
 151   height = max (height, min (height * ff, max_h));
 152
 153   curve.control_[0] = attachment_[LEFT];
 154   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 155     + dz_unit * x1;
 156   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 157     + dz_unit * x2;
 158   curve.control_[3] = attachment_[RIGHT];
 159
 160   curve_ = avoid_staff_line (state, curve);
 161   height_ = height;
 162 }
 163
 164 Slur_configuration::Slur_configuration ()
 165 {
 166   score_ = 0.0;
 167   index_ = -1;
 168 };
 169
 170 void
 171 Slur_configuration::score_encompass (Slur_score_state const &state)
 172 {
 173   Bezier const &bez (curve_);
 174   Real demerit = 0.0;
 175
 176   /*
 177     Distances for heads that are between slur and line between
 178     attachment points.
 179   */
 180   Array<Real> convex_head_distances;
 181   for (int j = 0; j < state.encompass_infos_.size (); j++)
 182     {
 183       Real x = state.encompass_infos_[j].x_;
 184
 185       bool l_edge = j == 0;
 186       bool r_edge = j == state.encompass_infos_.size () - 1;
 187       bool edge = l_edge || r_edge;
 188
 189       if (! (x < attachment_[RIGHT][X_AXIS]
 190              && x > attachment_[LEFT][X_AXIS]))
 191         continue;
 192
 193       Real y = bez.get_other_coordinate (X_AXIS, x);
 194       if (!edge)
 195         {
 196           Real head_dy = (y - state.encompass_infos_[j].head_);
 197           if (state.dir_ * head_dy < 0)
 198             {
 199               demerit += state.parameters_.head_encompass_penalty_;
 200               convex_head_distances.push (0.0);
 201             }
 202           else
 203             {
 204               Real hd = (head_dy)
 205                 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 206                 : state.parameters_.head_encompass_penalty_;
 207               hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
 208
 209               demerit += hd;
 210             }
 211
 212           Real line_y = linear_interpolate (x,
 213                                             attachment_[RIGHT][X_AXIS],
 214                                             attachment_[LEFT][X_AXIS],
 215                                             attachment_[RIGHT][Y_AXIS],
 216                                             attachment_[LEFT][Y_AXIS]);
 217
 218           if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 219             {
 220
 221               Real closest
 222                 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
 223               Real d = fabs (closest - y);
 224
 225               convex_head_distances.push (d);
 226             }
 227         }
 228
 229       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 230         {
 231           Real stem_dem = state.parameters_.stem_encompass_penalty_;
 232           if ((l_edge && state.dir_ == UP)
 233               || (r_edge && state.dir_ == DOWN))
 234             stem_dem /= 5;
 235
 236           demerit += stem_dem;
 237         }
 238       else if (!edge)
 239         {
 240           Interval ext;
 241           ext.add_point (state.encompass_infos_[j].stem_);
 242           ext.add_point (state.encompass_infos_[j].head_);
 243
 244           // ?
 245           demerit += -state.parameters_.closeness_factor_
 246             * min (state.dir_
 247                    * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
 248             / state.encompass_infos_.size ();
 249         }
 250     }
 251
 252   Real variance_penalty = 0.0;
 253
 254   if (convex_head_distances.size ())
 255     {
 256       Real avg_distance = 0.0;
 257       Real min_dist = infinity_f;
 258       for (int j = 0; j < convex_head_distances.size (); j++)
 259         {
 260           min_dist = min (min_dist, convex_head_distances[j]);
 261           avg_distance += convex_head_distances[j];
 262         }
 263
 264       /*
 265         For slurs over 3 or 4 heads, the average distance is not a
 266         good normalizer.
 267       */
 268       Real n = convex_head_distances.size ();
 269       if (n <= 2)
 270         {
 271           Real fact = 1.0;
 272           avg_distance += height_ * fact;
 273           n += fact;
 274         }
 275
 276       /*
 277         TODO: maybe it's better to use (avgdist - mindist)*factor
 278         as penalty.
 279       */
 280       avg_distance /= n;
 281       variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 282       if (min_dist > 0.0)
 283         variance_penalty
 284           = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
 285
 286       variance_penalty = max (variance_penalty, 0.0);
 287       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 288     }
 289
 290 #if DEBUG_SLUR_SCORING
 291   score_card_ += to_string ("C%.2f", demerit);
 292   score_card_ += to_string ("D%.2f", variance_penalty);
 293 #endif
 294
 295   score_ += demerit + variance_penalty;
 296 }
 297
 298 void
 299 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 300 {
 301   Real demerit = 0.0;
 302   for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
 303     {
 304       Drul_array<Offset> attachment = attachment_;
 305       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 306
 307       /*
 308         to prevent numerical inaccuracies in
 309         Bezier::get_other_coordinate ().
 310       */
 311       Direction d = LEFT;
 312       bool found = false;
 313       Real y = 0.0;
 314
 315       do
 316         {
 317           /*
 318             We need to check for the bound explicitly, since the
 319             slur-ending can be almost vertical, making the Y
 320             coordinate a bad approximation of the object-slur
 321             distance.
 322           */
 323           Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
 324           if ((as_item
 325                && as_item->get_column ()
 326                == state.extremes_[d].bound_->get_column ())
 327               || state.extra_encompass_infos_[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
 328             {
 329               y = attachment[d][Y_AXIS];
 330               found = true;
 331             }
 332         }
 333       while (flip (&d) != LEFT);
 334
 335       if (!found)
 336         {
 337           Real x = state.extra_encompass_infos_[j].extents_[X_AXIS]
 338             .linear_combination (state.extra_encompass_infos_[j].idx_);
 339
 340           if (!slur_wid.contains (x))
 341             continue;
 342
 343           y = curve_.get_other_coordinate (X_AXIS, x);
 344         }
 345
 346       Real dist = state.extra_encompass_infos_[j].extents_[Y_AXIS].distance (y);
 347       demerit
 348         += fabs (max (0.0, (state.parameters_.extra_encompass_free_distance_ - dist)))
 349         / state.parameters_.extra_encompass_free_distance_
 350         * state.extra_encompass_infos_[j].penalty_;
 351     }
 352 #if DEBUG_SLUR_SCORING
 353   score_card_ += to_string ("X%.2f", demerit);
 354 #endif
 355   score_ += demerit;
 356 }
 357
 358 void
 359 Slur_configuration::score_edges (Slur_score_state const &state)
 360 {
 361   Direction d = LEFT;
 362   Offset dz = attachment_[RIGHT]
 363     - attachment_[LEFT];
 364   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 365   do
 366     {
 367       Real y = attachment_[d][Y_AXIS];
 368       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 369
 370       Real factor = state.parameters_.edge_attraction_factor_;
 371       Real demerit = factor * dy;
 372       if (state.extremes_[d].stem_
 373           && state.extremes_[d].stem_dir_ == state.dir_
 374           && !Stem::get_beaming (state.extremes_[d].stem_, -d))
 375         demerit /= 5;
 376
 377       demerit *= exp (state.dir_ * d * slope
 378                       * state.parameters_.edge_slope_exponent_);
 379
 380       score_ += demerit;
 381 #if DEBUG_SLUR_SCORING
 382       score_card_ += to_string ("E%.2f", demerit);
 383 #endif
 384     }
 385   while (flip (&d) != LEFT);
 386 }
 387
 388 void
 389 Slur_configuration ::score_slopes (Slur_score_state const &state)
 390 {
 391   Real dy = state.musical_dy_;
 392   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
 393   Real slur_dy = slur_dz[Y_AXIS];
 394   Real demerit = 0.0;
 395
 396   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 397                    - state.parameters_.max_slope_), 0.0)
 398     * state.parameters_.max_slope_factor_;
 399
 400   /* 0.2: account for staffline offset. */
 401   Real max_dy = (fabs (dy) + 0.2);
 402   if (state.edge_has_beams_)
 403     max_dy += 1.0;
 404
 405   if (!state.is_broken_)
 406     demerit += state.parameters_.steeper_slope_factor_
 407       * (max (fabs (slur_dy) -max_dy, 0.0));
 408
 409   demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
 410                    - state.parameters_.max_slope_), 0.0)
 411     * state.parameters_.max_slope_factor_;
 412
 413   if (sign (dy) == 0
 414       && sign (slur_dy) != 0
 415       && !state.is_broken_)
 416     demerit += state.parameters_.non_horizontal_penalty_;
 417
 418   if (sign (dy)
 419       && !state.is_broken_
 420       && sign (slur_dy)
 421       && sign (slur_dy) != sign (dy))
 422     demerit += state.edge_has_beams_
 423       ? state.parameters_.same_slope_penalty_ / 10
 424       : state.parameters_.same_slope_penalty_;
 425
 426 #if DEBUG_SLUR_SCORING
 427   score_card_ += to_string ("S%.2f", demerit);
 428 #endif
 429   score_ += demerit;
 430 }
 431
 432 void
 433 Slur_configuration::score (Slur_score_state const &state)
 434 {
 435   score_extra_encompass (state);
 436   score_slopes (state);
 437   score_edges (state);
 438   score_encompass (state);
 439 }