2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 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"
38 avoid_staff_line (Slur_score_state const &state,
42 vector<Real> ts = bez.solve_derivative (horiz);
44 /* TODO: handle case of broken slur. */
46 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
47 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
49 Real t = ts[0]; //the first (usually only) point where slur is horizontal
50 Real y = bez.curve_point (t)[Y_AXIS];
51 // A Bezier curve at t moves 3t-3t² as far as the middle control points
52 Real factor = 3.0 * t * (1.0 - t);
54 Grob *staff = state.extremes_[LEFT].staff_;
56 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
59 int round_p = (int) my_round (p);
60 if (!Staff_symbol_referencer::on_staff_line (staff, round_p))
61 round_p += (p > round_p) ? 1 : -1;
62 if (!Staff_symbol_referencer::on_staff_line (staff, round_p))
65 Real const distance = (p - round_p) * state.staff_space_ / 2.0;
66 // Allow half the thickness of the slur at the point t, plus one basic
67 // blot-diameter (half for the slur outline, half for the staff line)
68 Real const min_distance = 0.5 * state.thickness_ * factor
69 + state.line_thickness_
70 + ((state.dir_ * distance > 0.0)
71 ? state.parameters_.gap_to_staffline_inside_
72 : state.parameters_.gap_to_staffline_outside_);
73 if (fabs (distance) < min_distance)
75 Direction resolution_dir = (distance > 0.0) ? UP : DOWN;
77 Real dy = resolution_dir * (min_distance - fabs (distance));
79 // Shape the curve, moving the horizontal point by factor * dy
80 bez.control_[1][Y_AXIS] += dy;
81 bez.control_[2][Y_AXIS] += dy;
82 // Move the entire curve by the remaining amount
83 bez.translate (Offset (0.0, dy - factor * dy));
90 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
91 Bezier curve, Direction d, vector<Offset> const &avoid)
93 Real fit_factor = 0.0;
94 Offset x0 = curve.control_[0];
95 curve.translate (-x0);
96 curve.rotate (-dz_unit.arg ());
100 curve_xext.add_point (curve.control_[0][X_AXIS]);
101 curve_xext.add_point (curve.control_[3][X_AXIS]);
103 for (vsize i = 0; i < avoid.size (); i++)
105 Offset z = (avoid[i] - x0);
106 Offset p (dot_product (z, dz_unit),
107 d * dot_product (z, dz_perp));
109 bool close_to_edge = false;
110 for (LEFT_and_RIGHT (d))
111 close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
117 Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
118 pext.intersect (curve_xext);
120 if (pext.is_empty () || pext.length () <= 1.999 * eps)
123 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
125 fit_factor = std::max (fit_factor, (p[Y_AXIS] / y));
131 Slur_configuration::generate_curve (Slur_score_state const &state,
132 Real r_0, Real h_inf,
133 vector<Offset> const &avoid)
135 Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
137 dz_unit *= 1 / dz.length ();
138 Offset dz_perp = dz_unit * Offset (0, 1);
141 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
143 Real len = dz.length ();
147 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
151 |bez' (0)| < | bez' (.5)|
153 when (control2 - control1) has the same direction as
154 (control3 - control0). */
156 Real max_indent = len / 3.1;
157 indent = std::min (indent, max_indent);
159 Real a1 = sqr (len) / 3.0;
160 Real a2 = 0.75 * sqr (indent + len / 3.0);
161 Real max_h = a1 - a2;
165 programming_error ("slur indent too small");
169 max_h = sqrt (max_h);
171 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
173 Real x1 = (eccentricity + indent);
174 Real x2 = (eccentricity - indent);
177 curve.control_[0] = attachment_[LEFT];
178 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
180 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
182 curve.control_[3] = attachment_[RIGHT];
184 Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
185 curve, state.dir_, avoid);
187 height = std::max (height, std::min (height * ff, max_h));
189 curve.control_[0] = attachment_[LEFT];
190 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
192 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
194 curve.control_[3] = attachment_[RIGHT];
196 curve_ = avoid_staff_line (state, curve);
200 Slur_configuration::Slur_configuration ()
207 Slur_configuration::add_score (Real s, const string &desc)
211 programming_error ("Negative demerits found for slur. Ignoring");
217 if (score_card_.length () > 0)
219 score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
225 Slur_configuration::score_encompass (Slur_score_state const &state)
227 Bezier const &bez (curve_);
231 Distances for heads that are between slur and line between
234 vector<Real> convex_head_distances;
235 for (vsize j = 0; j < state.encompass_infos_.size (); j++)
237 Real x = state.encompass_infos_[j].x_;
239 bool l_edge = j == 0;
240 bool r_edge = j == state.encompass_infos_.size () - 1;
241 bool edge = l_edge || r_edge;
243 if (! (x < attachment_[RIGHT][X_AXIS]
244 && x > attachment_[LEFT][X_AXIS]))
247 Real y = bez.get_other_coordinate (X_AXIS, x);
250 Real head_dy = (y - state.encompass_infos_[j].head_);
251 if (state.dir_ * head_dy < 0)
253 demerit += state.parameters_.head_encompass_penalty_;
254 convex_head_distances.push_back (0.0);
259 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
260 : state.parameters_.head_encompass_penalty_;
261 hd = std::min (std::max (hd, 0.0), state.parameters_.head_encompass_penalty_);
266 Real line_y = linear_interpolate (x,
267 attachment_[RIGHT][X_AXIS],
268 attachment_[LEFT][X_AXIS],
269 attachment_[RIGHT][Y_AXIS],
270 attachment_[LEFT][Y_AXIS]);
272 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
276 = state.dir_ * std::max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
277 Real d = fabs (closest - y);
279 convex_head_distances.push_back (d);
283 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
285 Real stem_dem = state.parameters_.stem_encompass_penalty_;
286 if ((l_edge && state.dir_ == UP)
287 || (r_edge && state.dir_ == DOWN))
293 add_score (demerit, "encompass");
295 if (vsize n = convex_head_distances.size ())
297 Real avg_distance = 0.0;
298 Real min_dist = infinity_f;
300 for (vsize j = 0; j < n; j++)
302 min_dist = std::min (min_dist, convex_head_distances[j]);
303 avg_distance += convex_head_distances[j];
307 For slurs over 3 or 4 heads, the average distance is not a
313 avg_distance += height_ * fact;
318 TODO: maybe it's better to use (avgdist - mindist)*factor
322 Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
325 = std::min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
327 variance_penalty = std::max (variance_penalty, 0.0);
328 variance_penalty *= state.parameters_.head_slur_distance_factor_;
330 add_score (variance_penalty, "variance");
335 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
337 // we find forbidden attachments
338 vector<Offset> forbidden_attachments;
339 for (vsize i = 0; i < state.extra_encompass_infos_.size (); i++)
340 if (has_interface<Tie> (state.extra_encompass_infos_[i].grob_))
342 Grob *t = state.extra_encompass_infos_[i].grob_;
343 Grob *common_x = Grob::get_vertical_axis_group (t);
344 Real rp = t->relative_coordinate (common_x, X_AXIS);
345 SCM cp = t->get_property ("control-points");
349 for (SCM s = cp; scm_is_pair (s); s = scm_cdr (s))
351 b.control_[j] = ly_scm2offset (scm_car (s));
354 forbidden_attachments.push_back (Offset (b.control_[0]) + Offset (rp, 0));
355 forbidden_attachments.push_back (Offset (b.control_[3]) + Offset (rp, 0));
358 bool too_close = false;
359 for (vsize k = 0; k < forbidden_attachments.size (); k++)
360 for (LEFT_and_RIGHT (side))
361 if ((forbidden_attachments[k] - attachment_[side]).length () < state.parameters_.slur_tie_extrema_min_distance_)
368 add_score (state.parameters_.slur_tie_extrema_min_distance_penalty_, "extra");
370 for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
372 Drul_array<Offset> attachment = attachment_;
373 Extra_collision_info const &info (state.extra_encompass_infos_[j]);
375 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
378 to prevent numerical inaccuracies in
379 Bezier::get_other_coordinate ().
385 for (LEFT_and_RIGHT (d))
388 We need to check for the bound explicitly, since the
389 slur-ending can be almost vertical, making the Y
390 coordinate a bad approximation of the object-slur
393 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
397 Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
398 item_x.intersect (state.extremes_[d].slur_head_x_extent_);
399 if (!item_x.is_empty ())
401 y = attachment[d][Y_AXIS];
409 Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
411 if (!slur_wid.contains (x))
414 y = curve_.get_other_coordinate (X_AXIS, x);
418 if (scm_is_eq (info.type_, ly_symbol2scm ("around")))
419 dist = info.extents_[Y_AXIS].distance (y);
422 Have to score too: the curve enumeration is limited in its
423 shape, and may produce curves which collide anyway.
425 else if (scm_is_eq (info.type_, ly_symbol2scm ("inside")))
426 dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
428 programming_error ("unknown avoidance type");
430 dist = std::max (dist, 0.0);
432 Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
433 state.parameters_.extra_encompass_free_distance_,
436 add_score (penalty, "extra");
441 Slur_configuration::score_edges (Slur_score_state const &state)
444 Offset dz = attachment_[RIGHT]
446 Real slope = dz[Y_AXIS] / dz[X_AXIS];
447 for (LEFT_and_RIGHT (d))
449 Real y = attachment_[d][Y_AXIS];
450 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
452 Real factor = state.parameters_.edge_attraction_factor_;
453 Real demerit = factor * dy;
454 if (state.extremes_[d].stem_
455 && state.extremes_[d].stem_dir_ == state.dir_
456 // TODO - Stem::get_beaming() should be precomputed.
457 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
460 demerit *= exp (state.dir_ * d * slope
461 * state.parameters_.edge_slope_exponent_);
463 string dir_str = d == LEFT ? "L" : "R";
464 add_score (demerit, dir_str + " edge");
469 Slur_configuration::score_slopes (Slur_score_state const &state)
471 Real dy = state.musical_dy_;
472 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
473 Real slur_dy = slur_dz[Y_AXIS];
476 demerit += std::max ((fabs (slur_dy / slur_dz[X_AXIS])
477 - state.parameters_.max_slope_), 0.0)
478 * state.parameters_.max_slope_factor_;
480 /* 0.2: account for staffline offset. */
481 Real max_dy = (fabs (dy) + 0.2);
482 if (state.edge_has_beams_)
485 if (!state.is_broken_)
486 demerit += state.parameters_.steeper_slope_factor_
487 * (std::max (fabs (slur_dy) - max_dy, 0.0));
489 demerit += std::max ((fabs (slur_dy / slur_dz[X_AXIS])
490 - state.parameters_.max_slope_), 0.0)
491 * state.parameters_.max_slope_factor_;
494 && sign (slur_dy) != 0
495 && !state.is_broken_)
496 demerit += state.parameters_.non_horizontal_penalty_;
501 && sign (slur_dy) != sign (dy))
502 demerit += state.edge_has_beams_
503 ? state.parameters_.same_slope_penalty_ / 10
504 : state.parameters_.same_slope_penalty_;
506 add_score (demerit, "slope");
509 // This is a temporary hack to see how much we can gain by using a
510 // priority queue on the beams to score.
511 static int score_count = 0;
512 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
514 "count number of slur scores.")
516 return scm_from_int (score_count);
520 Slur_configuration::run_next_scorer (Slur_score_state const &state)
522 switch (next_scorer_todo)
524 case EXTRA_ENCOMPASS:
525 score_extra_encompass (state);
528 score_slopes (state);
534 score_encompass (state);
544 Slur_configuration::done () const
546 return next_scorer_todo >= NUM_SCORERS;
550 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
552 Slur_configuration *conf = new Slur_configuration;
553 conf->attachment_ = offs;
555 conf->next_scorer_todo = INITIAL_SCORE + 1;