2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "slur-configuration.hh"
23 #include "libc-extension.hh"
25 #include "pointer-group-interface.hh"
26 #include "slur-scoring.hh"
29 #include "staff-symbol-referencer.hh"
35 avoid_staff_line (Slur_score_state const &state,
39 vector<Real> ts = bez.solve_derivative (horiz);
41 /* TODO: handle case of broken slur. */
43 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
44 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
46 Real t = ts[0]; //the first (usually only) point where slur is horizontal
47 Real y = bez.curve_point (t)[Y_AXIS];
48 // A Bezier curve at t moves 3t-3t² as far as the middle control points
49 Real factor = 3.0 * t * (1.0 - t);
51 Grob *staff = state.extremes_[LEFT].staff_;
53 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
56 int round_p = (int) my_round (p);
57 if (!Staff_symbol_referencer::on_staff_line (staff, round_p))
58 round_p += (p > round_p) ? 1 : -1;
59 if (!Staff_symbol_referencer::on_staff_line (staff, round_p))
62 Real const distance = (p - round_p) * state.staff_space_ / 2.0;
63 // Allow half the thickness of the slur at the point t, plus one basic
64 // blot-diameter (half for the slur outline, half for the staff line)
65 Real const min_distance = 0.5 * state.thickness_ * factor
66 + state.line_thickness_
67 + ((state.dir_ * distance > 0.0)
68 ? state.parameters_.gap_to_staffline_inside_
69 : state.parameters_.gap_to_staffline_outside_);
70 if (fabs (distance) < min_distance)
72 Direction resolution_dir = (distance > 0.0) ? UP : DOWN;
74 Real dy = resolution_dir * (min_distance - fabs (distance));
76 // Shape the curve, moving the horizontal point by factor * dy
77 bez.control_[1][Y_AXIS] += dy;
78 bez.control_[2][Y_AXIS] += dy;
79 // Move the entire curve by the remaining amount
80 bez.translate (Offset (0.0, dy - factor * dy));
87 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
88 Bezier curve, Direction d, vector<Offset> const &avoid)
90 Real fit_factor = 0.0;
91 Offset x0 = curve.control_[0];
92 curve.translate (-x0);
93 curve.rotate (-dz_unit.arg ());
97 curve_xext.add_point (curve.control_[0][X_AXIS]);
98 curve_xext.add_point (curve.control_[3][X_AXIS]);
100 for (vsize i = 0; i < avoid.size (); i++)
102 Offset z = (avoid[i] - x0);
103 Offset p (dot_product (z, dz_unit),
104 d * dot_product (z, dz_perp));
106 bool close_to_edge = false;
107 for (LEFT_and_RIGHT (d))
108 close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
114 Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
115 pext.intersect (curve_xext);
117 if (pext.is_empty () || pext.length () <= 1.999 * eps)
120 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
122 fit_factor = max (fit_factor, (p[Y_AXIS] / y));
128 Slur_configuration::generate_curve (Slur_score_state const &state,
129 Real r_0, Real h_inf,
130 vector<Offset> const &avoid)
132 Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
134 dz_unit *= 1 / dz.length ();
135 Offset dz_perp = dz_unit * Offset (0, 1);
138 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
140 Real len = dz.length ();
144 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
148 |bez' (0)| < | bez' (.5)|
150 when (control2 - control1) has the same direction as
151 (control3 - control0). */
153 Real max_indent = len / 3.1;
154 indent = min (indent, max_indent);
156 Real a1 = sqr (len) / 3.0;
157 Real a2 = 0.75 * sqr (indent + len / 3.0);
158 Real max_h = a1 - a2;
162 programming_error ("slur indent too small");
166 max_h = sqrt (max_h);
168 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
170 Real x1 = (eccentricity + indent);
171 Real x2 = (eccentricity - indent);
174 curve.control_[0] = attachment_[LEFT];
175 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
177 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
179 curve.control_[3] = attachment_[RIGHT];
181 Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
182 curve, state.dir_, avoid);
184 height = max (height, min (height * ff, max_h));
186 curve.control_[0] = attachment_[LEFT];
187 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
189 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
191 curve.control_[3] = attachment_[RIGHT];
193 curve_ = avoid_staff_line (state, curve);
197 Slur_configuration::Slur_configuration ()
204 Slur_configuration::add_score (Real s, const string &desc)
208 programming_error ("Negative demerits found for slur. Ignoring");
214 if (score_card_.length () > 0)
216 score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
222 Slur_configuration::score_encompass (Slur_score_state const &state)
224 Bezier const &bez (curve_);
228 Distances for heads that are between slur and line between
231 vector<Real> convex_head_distances;
232 for (vsize j = 0; j < state.encompass_infos_.size (); j++)
234 Real x = state.encompass_infos_[j].x_;
236 bool l_edge = j == 0;
237 bool r_edge = j == state.encompass_infos_.size () - 1;
238 bool edge = l_edge || r_edge;
240 if (! (x < attachment_[RIGHT][X_AXIS]
241 && x > attachment_[LEFT][X_AXIS]))
244 Real y = bez.get_other_coordinate (X_AXIS, x);
247 Real head_dy = (y - state.encompass_infos_[j].head_);
248 if (state.dir_ * head_dy < 0)
250 demerit += state.parameters_.head_encompass_penalty_;
251 convex_head_distances.push_back (0.0);
256 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
257 : state.parameters_.head_encompass_penalty_;
258 hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
263 Real line_y = linear_interpolate (x,
264 attachment_[RIGHT][X_AXIS],
265 attachment_[LEFT][X_AXIS],
266 attachment_[RIGHT][Y_AXIS],
267 attachment_[LEFT][Y_AXIS]);
269 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
273 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
274 Real d = fabs (closest - y);
276 convex_head_distances.push_back (d);
280 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
282 Real stem_dem = state.parameters_.stem_encompass_penalty_;
283 if ((l_edge && state.dir_ == UP)
284 || (r_edge && state.dir_ == DOWN))
290 add_score (demerit, "encompass");
292 if (vsize n = convex_head_distances.size ())
294 Real avg_distance = 0.0;
295 Real min_dist = infinity_f;
297 for (vsize j = 0; j < n; j++)
299 min_dist = min (min_dist, convex_head_distances[j]);
300 avg_distance += convex_head_distances[j];
304 For slurs over 3 or 4 heads, the average distance is not a
310 avg_distance += height_ * fact;
315 TODO: maybe it's better to use (avgdist - mindist)*factor
319 Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
322 = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
324 variance_penalty = max (variance_penalty, 0.0);
325 variance_penalty *= state.parameters_.head_slur_distance_factor_;
327 add_score (variance_penalty, "variance");
332 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
334 // we find forbidden attachments
335 vector<Offset> forbidden_attachments;
336 for (vsize i = 0; i < state.extra_encompass_infos_.size (); i++)
337 if (Tie::has_interface (state.extra_encompass_infos_[i].grob_))
339 Grob *t = state.extra_encompass_infos_[i].grob_;
340 Grob *common_x = Grob::get_vertical_axis_group (t);
341 Real rp = t->relative_coordinate (common_x, X_AXIS);
342 SCM cp = t->get_property ("control-points");
346 for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
348 b.control_[j] = ly_scm2offset (scm_car (s));
351 forbidden_attachments.push_back (Offset (b.control_[0]) + Offset (rp, 0));
352 forbidden_attachments.push_back (Offset (b.control_[3]) + Offset (rp, 0));
355 bool too_close = false;
356 for (vsize k = 0; k < forbidden_attachments.size (); k++)
357 for (LEFT_and_RIGHT (side))
358 if ((forbidden_attachments[k] - attachment_[side]).length () < state.parameters_.slur_tie_extrema_min_distance_)
365 add_score (state.parameters_.slur_tie_extrema_min_distance_penalty_, "extra");
367 for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
369 Drul_array<Offset> attachment = attachment_;
370 Extra_collision_info const &info (state.extra_encompass_infos_[j]);
372 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
375 to prevent numerical inaccuracies in
376 Bezier::get_other_coordinate ().
382 for (LEFT_and_RIGHT (d))
385 We need to check for the bound explicitly, since the
386 slur-ending can be almost vertical, making the Y
387 coordinate a bad approximation of the object-slur
390 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
394 Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
395 item_x.intersect (state.extremes_[d].slur_head_x_extent_);
396 if (!item_x.is_empty ())
398 y = attachment[d][Y_AXIS];
406 Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
408 if (!slur_wid.contains (x))
411 y = curve_.get_other_coordinate (X_AXIS, x);
415 if (info.type_ == ly_symbol2scm ("around"))
416 dist = info.extents_[Y_AXIS].distance (y);
419 Have to score too: the curve enumeration is limited in its
420 shape, and may produce curves which collide anyway.
422 else if (info.type_ == ly_symbol2scm ("inside"))
423 dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
425 programming_error ("unknown avoidance type");
427 dist = max (dist, 0.0);
429 Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
430 state.parameters_.extra_encompass_free_distance_,
433 add_score (penalty, "extra");
438 Slur_configuration::score_edges (Slur_score_state const &state)
441 Offset dz = attachment_[RIGHT]
443 Real slope = dz[Y_AXIS] / dz[X_AXIS];
444 for (LEFT_and_RIGHT (d))
446 Real y = attachment_[d][Y_AXIS];
447 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
449 Real factor = state.parameters_.edge_attraction_factor_;
450 Real demerit = factor * dy;
451 if (state.extremes_[d].stem_
452 && state.extremes_[d].stem_dir_ == state.dir_
453 // TODO - Stem::get_beaming() should be precomputed.
454 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
457 demerit *= exp (state.dir_ * d * slope
458 * state.parameters_.edge_slope_exponent_);
460 string dir_str = d == LEFT ? "L" : "R";
461 add_score (demerit, dir_str + " edge");
466 Slur_configuration::score_slopes (Slur_score_state const &state)
468 Real dy = state.musical_dy_;
469 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
470 Real slur_dy = slur_dz[Y_AXIS];
473 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
474 - state.parameters_.max_slope_), 0.0)
475 * state.parameters_.max_slope_factor_;
477 /* 0.2: account for staffline offset. */
478 Real max_dy = (fabs (dy) + 0.2);
479 if (state.edge_has_beams_)
482 if (!state.is_broken_)
483 demerit += state.parameters_.steeper_slope_factor_
484 * (max (fabs (slur_dy) - max_dy, 0.0));
486 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
487 - state.parameters_.max_slope_), 0.0)
488 * state.parameters_.max_slope_factor_;
491 && sign (slur_dy) != 0
492 && !state.is_broken_)
493 demerit += state.parameters_.non_horizontal_penalty_;
498 && sign (slur_dy) != sign (dy))
499 demerit += state.edge_has_beams_
500 ? state.parameters_.same_slope_penalty_ / 10
501 : state.parameters_.same_slope_penalty_;
503 add_score (demerit, "slope");
506 // This is a temporary hack to see how much we can gain by using a
507 // priority queue on the beams to score.
508 static int score_count = 0;
509 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
511 "count number of slur scores.")
513 return scm_from_int (score_count);
517 Slur_configuration::run_next_scorer (Slur_score_state const &state)
519 switch (next_scorer_todo)
521 case EXTRA_ENCOMPASS:
522 score_extra_encompass (state);
525 score_slopes (state);
531 score_encompass (state);
541 Slur_configuration::done () const
543 return next_scorer_todo >= NUM_SCORERS;
547 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
549 Slur_configuration *conf = new Slur_configuration;
550 conf->attachment_ = offs;
552 conf->next_scorer_todo = INITIAL_SCORE + 1;