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 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #include <math.h>
  11
  12 #include "stem.hh"
  13 #include "warn.hh"
  14 #include "misc.hh"
  15 #include "item.hh"
  16 #include "group-interface.hh"
  17 #include "slur.hh"
  18 #include "slur-scoring.hh"
  19 #include "slur-configuration.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         {
  91           fit_factor = fit_factor >? (p[Y_AXIS] / y);
  92         }
  93     }
  94   return fit_factor;
  95 }
  96
  97 void
  98 Slur_configuration::generate_curve (Slur_score_state const &state,
  99                                     Real r_0, Real h_inf )
 100 {
 101   Link_array<Grob> encompasses = state.columns_;
 102
 103   Array<Offset> avoid;
 104   for (int i = 0; i < encompasses.size (); i++)
 105     {
 106       if (state.extremes_[LEFT].note_column_ == encompasses[i]
 107           || state.extremes_[RIGHT].note_column_ == encompasses[i])
 108         continue;
 109
 110       Encompass_info inf (state.get_encompass_info (encompasses[i]));
 111       Real y = state.dir_ * ((state.dir_ * inf.head_) >? (state.dir_ *inf.stem_));
 112
 113       avoid.push (Offset (inf.x_,  y + state.dir_ * state.parameters_.free_head_distance_));
 114     }
 115
 116   Link_array<Grob> extra_encompasses
 117     = Pointer_group_interface__extract_grobs (state.slur_, (Grob *)0, "encompass-objects");
 118   for (int i = 0;  i < extra_encompasses.size (); i++)
 119     if (Slur::has_interface (extra_encompasses[i]))
 120       {
 121         Grob * small_slur = extra_encompasses[i];
 122         Bezier b = Slur::get_curve (small_slur);
 123
 124         Offset z = b.curve_point (0.5);
 125         z += Offset (small_slur->relative_coordinate (state.common_[X_AXIS], X_AXIS),
 126                      small_slur->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
 127
 128         z[Y_AXIS] += state.dir_ * state.parameters_.free_slur_distance_;
 129         avoid.push (z);
 130       }
 131
 132   Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
 133   Offset dz_unit = dz;
 134   dz_unit *= 1 / dz.length ();
 135   Offset dz_perp = dz_unit * Offset (0, 1);
 136
 137   Real indent, height;
 138   get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
 139
 140
 141   Real len = dz.length ();
 142
 143   /* This condition,
 144
 145      len^2 > 4h^2 +  3 (i + 1/3len)^2  - 1/3 len^2
 146
 147      is equivalent to:
 148
 149      |bez' (0)| < | bez' (.5)|
 150
 151      when (control2 - control1) has the same direction as
 152     (control3 - control0).  */
 153
 154
 155
 156   Real max_indent = len / 3.1;
 157   indent = indent <? max_indent;
 158
 159   Real a1 = sqr (len) / 3.0;
 160   Real a2 = 0.75 * sqr (indent + len / 3.0);
 161   Real max_h = a1 - a2;
 162
 163
 164   if (max_h < 0)
 165     {
 166       programming_error ("Slur indent too small.");
 167       max_h = len / 3.0 ;
 168     }
 169   else
 170     {
 171       max_h = sqrt (max_h);
 172     }
 173
 174   Real excentricity = robust_scm2double (state.slur_->get_property ("excentricity"), 0);
 175
 176   Real x1 = (excentricity + indent);
 177   Real x2 = (excentricity - indent);
 178
 179   Bezier curve;
 180   curve.control_[0] = attachment_[LEFT];
 181   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 182     + dz_unit * x1;
 183   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 184     + dz_unit * x2;
 185   curve.control_[3] = attachment_[RIGHT];
 186
 187   Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
 188
 189   height = height >? ((height * ff) <? max_h);
 190
 191   curve.control_[0] = attachment_[LEFT];
 192   curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
 193     + dz_unit * x1;
 194   curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
 195     + dz_unit * x2;
 196   curve.control_[3] = attachment_[RIGHT];
 197
 198   curve_ = avoid_staff_line (state, curve);
 199   height_ = height;
 200 }
 201
 202 Slur_configuration::Slur_configuration()
 203 {
 204   score_ = 0.0;
 205   index_ = -1;
 206 };
 207
 208
 209
 210
 211 void
 212 Slur_configuration::score_encompass (Slur_score_state const &state)
 213 {
 214   Bezier const &bez (curve_);
 215   Real demerit = 0.0;
 216
 217   /*
 218     Distances for heads that are between slur and line between
 219     attachment points.
 220   */
 221   Array<Real> convex_head_distances;
 222   for (int j = 0; j < state.encompass_infos_.size (); j++)
 223     {
 224       Real x = state.encompass_infos_[j].x_;
 225
 226       bool l_edge = j==0;
 227       bool r_edge = j==state.encompass_infos_.size ()-1;
 228       bool edge =  l_edge || r_edge;
 229
 230       if (! (x < attachment_[RIGHT][X_AXIS]
 231              && x > attachment_[LEFT][X_AXIS]))
 232         continue;
 233
 234       Real y = bez.get_other_coordinate (X_AXIS, x);
 235       if (!edge)
 236         {
 237           Real head_dy = (y - state.encompass_infos_[j].head_);
 238           if (state.dir_ * head_dy < 0)
 239             {
 240               demerit += state.parameters_.head_encompass_penalty_;
 241               convex_head_distances.push (0.0);
 242             }
 243           else
 244             {
 245               Real hd = (head_dy)
 246                 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
 247                 : state.parameters_.head_encompass_penalty_;
 248               hd = (hd >? 0)<? state.parameters_.head_encompass_penalty_;
 249
 250               demerit += hd;
 251             }
 252
 253           Real line_y = linear_interpolate (x,
 254                                             attachment_[RIGHT][X_AXIS],
 255                                             attachment_[LEFT][X_AXIS],
 256                                             attachment_[RIGHT][Y_AXIS],
 257                                             attachment_[LEFT][Y_AXIS]);
 258
 259           if ( 1 ) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
 260             {
 261
 262               Real closest =
 263                 state.dir_ * (state.dir_ * state.encompass_infos_[j].get_point (state.dir_)
 264                               >? state.dir_ *line_y
 265                               );
 266               Real d = fabs (closest - y);
 267
 268               convex_head_distances.push (d);
 269             }
 270         }
 271
 272
 273
 274       if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
 275         {
 276           Real stem_dem =state.parameters_.stem_encompass_penalty_ ;
 277           if ((l_edge && state.dir_ == UP)
 278               || (r_edge && state.dir_ == DOWN))
 279             stem_dem /= 5;
 280
 281           demerit +=  stem_dem;
 282         }
 283       else if (!edge)
 284         {
 285           Interval ext;
 286           ext.add_point (state.encompass_infos_[j].stem_);
 287           ext.add_point (state.encompass_infos_[j].head_);
 288
 289           // ?
 290           demerit += -state.parameters_.closeness_factor_
 291             * (state.dir_
 292                * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_))
 293                <? 0)
 294             / state.encompass_infos_.size ();
 295         }
 296     }
 297
 298   Real variance_penalty = 0.0;
 299
 300   if (convex_head_distances.size ())
 301     {
 302       Real avg_distance = 0.0;
 303       Real min_dist = infinity_f;
 304       for (int j = 0; j < convex_head_distances.size (); j++)
 305         {
 306           min_dist = min_dist <? convex_head_distances[j];
 307           avg_distance += convex_head_distances[j];
 308         }
 309
 310       /*
 311         For slurs over 3 or 4 heads, the average distance is not a
 312         good normalizer.
 313       */
 314       Real n =  convex_head_distances.size ();
 315       if (n <= 2)
 316         {
 317           Real fact = 1.0;
 318           avg_distance += height_ * fact;
 319           n += fact;
 320         }
 321
 322       /*
 323         TODO: maybe it's better to use (avgdist - mindist)*factor
 324         as penalty.
 325       */
 326       avg_distance /= n;
 327       variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
 328       if (min_dist > 0.0)
 329         variance_penalty =
 330           (avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_ ) - 1.0)
 331           <? variance_penalty;
 332
 333       variance_penalty = variance_penalty >? 0.0;
 334       variance_penalty *= state.parameters_.head_slur_distance_factor_;
 335     }
 336
 337 #if DEBUG_SLUR_SCORING
 338   score_card_ += to_string ("C%.2f", demerit);
 339   score_card_ += to_string ("D%.2f", variance_penalty);
 340 #endif
 341
 342   score_ += demerit + variance_penalty;
 343 }
 344
 345 void
 346 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
 347 {
 348   Real demerit = 0.0;
 349   for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
 350     {
 351       Drul_array<Offset> attachment = attachment_;
 352       Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
 353
 354       /*
 355         to prevent numerical inaccuracies in
 356         Bezier::get_other_coordinate ().
 357       */
 358       Direction d = LEFT;
 359       bool found = false;
 360       Real y = 0.0;
 361
 362       do
 363         {
 364           /*
 365             We need to check for the bound explicitly, since the
 366             slur-ending can be almost vertical, making the Y
 367             coordinate a bad approximation of the object-slur
 368             distance.
 369           */
 370           Item * as_item =  dynamic_cast<Item*> (state.extra_encompass_infos_[j].grob_);
 371           if ((as_item
 372                && as_item->get_column ()
 373                == state.extremes_[d] .bound_->get_column ())
 374               || state.extra_encompass_infos_[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
 375             {
 376               y = attachment[d][Y_AXIS];
 377               found = true;
 378             }
 379         }
 380       while (flip (&d) != LEFT);
 381
 382       if (!found)
 383         {
 384           Real x = state.extra_encompass_infos_[j].extents_[X_AXIS]
 385             .linear_combination (state.extra_encompass_infos_[j].idx_);
 386
 387           if (!slur_wid.contains (x))
 388             continue;
 389
 390           y = curve_.get_other_coordinate (X_AXIS, x);
 391         }
 392
 393       Real dist = state.extra_encompass_infos_[j].extents_[Y_AXIS].distance (y);
 394       demerit +=
 395         fabs (0 >? (state.parameters_.extra_encompass_free_distance_ - dist)) /
 396         state.parameters_.extra_encompass_free_distance_
 397         * state.extra_encompass_infos_[j].penalty_;
 398     }
 399 #if DEBUG_SLUR_SCORING
 400   score_card_ += to_string ("X%.2f", demerit);
 401 #endif
 402   score_ += demerit;
 403 }
 404
 405 void
 406 Slur_configuration::score_edges (Slur_score_state const &state)
 407 {
 408   Direction d = LEFT;
 409   Offset dz = attachment_[RIGHT]
 410     - attachment_[LEFT];
 411   Real slope = dz[Y_AXIS] / dz[X_AXIS];
 412   do
 413     {
 414       Real y = attachment_[d][Y_AXIS];
 415       Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
 416
 417       Real factor = state.parameters_.edge_attraction_factor_;
 418       Real demerit = factor * dy;
 419       if (state.extremes_[d].stem_
 420           && state.extremes_[d].stem_dir_ == state.dir_
 421           && !Stem::get_beaming (state.extremes_[d].stem_, -d)
 422           )
 423         demerit /= 5;
 424
 425       demerit *= exp (state.dir_ * d * slope
 426                       * state.parameters_.edge_slope_exponent_ );
 427
 428       score_ += demerit;
 429 #if DEBUG_SLUR_SCORING
 430       score_card_ += to_string ("E%.2f", demerit);
 431 #endif
 432     }
 433   while (flip (&d) != LEFT);
 434 }
 435
 436 void
 437 Slur_configuration ::score_slopes (Slur_score_state const &state)
 438 {
 439   Real dy = state.musical_dy_;
 440   Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
 441   Real slur_dy = slur_dz[Y_AXIS];
 442   Real demerit = 0.0;
 443
 444   demerit += ((fabs (slur_dy / slur_dz[X_AXIS])
 445                - state.parameters_.max_slope_) >? 0)
 446     * state.parameters_.max_slope_factor_;
 447
 448   /* 0.2: account for staffline offset. */
 449   Real max_dy = (fabs (dy) + 0.2);
 450   if (state.edge_has_beams_)
 451     max_dy += 1.0;
 452
 453   if (!state.is_broken_)
 454     demerit += state.parameters_.steeper_slope_factor_
 455       * ((fabs (slur_dy) -max_dy) >? 0);
 456
 457   demerit += ((fabs (slur_dy/slur_dz[X_AXIS])
 458                - state.parameters_.max_slope_) >? 0)
 459     * state.parameters_.max_slope_factor_;
 460
 461   if (sign (dy) == 0
 462       && sign (slur_dy) != 0
 463       && !state.is_broken_)
 464     demerit += state.parameters_.non_horizontal_penalty_;
 465
 466   if (sign (dy)
 467       && !state.is_broken_
 468       && sign (slur_dy)
 469       && sign (slur_dy) != sign (dy))
 470     demerit += state.edge_has_beams_
 471       ? state.parameters_.same_slope_penalty_ / 10
 472       : state.parameters_.same_slope_penalty_;
 473
 474 #if DEBUG_SLUR_SCORING
 475   score_card_ += to_string ("S%.2f", demerit);
 476 #endif
 477   score_ += demerit;
 478 }
 479
 480
 481 void
 482 Slur_configuration::score (Slur_score_state const &state)
 483 {
 484   score_extra_encompass (state);
 485   score_slopes  (state);
 486   score_edges (state);
 487   score_encompass (state);
 488 }