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