2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2012 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"
34 avoid_staff_line (Slur_score_state const &state,
38 vector<Real> ts = bez.solve_derivative (horiz);
40 /* TODO: handle case of broken slur. */
42 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
43 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
45 Real y = bez.curve_point (ts[0])[Y_AXIS];
47 Grob *staff = state.extremes_[LEFT].staff_;
49 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
52 Real const round = my_round (p);
53 Real const frac = p - round;
54 if (fabs (frac) < 4 * state.thickness_
55 && Staff_symbol_referencer::on_staff_line (staff, int (round)))
57 Direction resolution_dir = frac ? state.dir_ : CENTER;
60 Real newp = round + resolution_dir * 5 * state.thickness_;
62 Real dy = (newp - p) * state.staff_space_ / 2.0;
64 bez.control_[1][Y_AXIS] += dy;
65 bez.control_[2][Y_AXIS] += dy;
72 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
73 Bezier curve, Direction d, vector<Offset> const &avoid)
75 Real fit_factor = 0.0;
76 Offset x0 = curve.control_[0];
77 curve.translate (-x0);
78 curve.rotate (-dz_unit.arg ());
82 curve_xext.add_point (curve.control_[0][X_AXIS]);
83 curve_xext.add_point (curve.control_[3][X_AXIS]);
85 for (vsize i = 0; i < avoid.size (); i++)
87 Offset z = (avoid[i] - x0);
88 Offset p (dot_product (z, dz_unit),
89 d * dot_product (z, dz_perp));
91 bool close_to_edge = false;
92 for (LEFT_and_RIGHT (d))
93 close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
99 Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
100 pext.intersect (curve_xext);
102 if (pext.is_empty () || pext.length () <= 1.999 * eps)
105 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
107 fit_factor = max (fit_factor, (p[Y_AXIS] / y));
113 Slur_configuration::generate_curve (Slur_score_state const &state,
114 Real r_0, Real h_inf,
115 vector<Offset> const &avoid)
117 Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
119 dz_unit *= 1 / dz.length ();
120 Offset dz_perp = dz_unit * Offset (0, 1);
123 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
125 Real len = dz.length ();
129 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
133 |bez' (0)| < | bez' (.5)|
135 when (control2 - control1) has the same direction as
136 (control3 - control0). */
138 Real max_indent = len / 3.1;
139 indent = min (indent, max_indent);
141 Real a1 = sqr (len) / 3.0;
142 Real a2 = 0.75 * sqr (indent + len / 3.0);
143 Real max_h = a1 - a2;
147 programming_error ("slur indent too small");
151 max_h = sqrt (max_h);
153 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
155 Real x1 = (eccentricity + indent);
156 Real x2 = (eccentricity - indent);
159 curve.control_[0] = attachment_[LEFT];
160 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
162 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
164 curve.control_[3] = attachment_[RIGHT];
166 Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
167 curve, state.dir_, avoid);
169 height = max (height, min (height * ff, max_h));
171 curve.control_[0] = attachment_[LEFT];
172 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
174 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
176 curve.control_[3] = attachment_[RIGHT];
178 curve_ = avoid_staff_line (state, curve);
182 Slur_configuration::Slur_configuration ()
189 Slur_configuration::add_score (Real s, string desc)
193 programming_error ("Negative demerits found for slur. Ignoring");
199 if (score_card_.length () > 0)
201 score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
207 Slur_configuration::score_encompass (Slur_score_state const &state)
209 Bezier const &bez (curve_);
213 Distances for heads that are between slur and line between
216 vector<Real> convex_head_distances;
217 for (vsize j = 0; j < state.encompass_infos_.size (); j++)
219 Real x = state.encompass_infos_[j].x_;
221 bool l_edge = j == 0;
222 bool r_edge = j == state.encompass_infos_.size () - 1;
223 bool edge = l_edge || r_edge;
225 if (! (x < attachment_[RIGHT][X_AXIS]
226 && x > attachment_[LEFT][X_AXIS]))
229 Real y = bez.get_other_coordinate (X_AXIS, x);
232 Real head_dy = (y - state.encompass_infos_[j].head_);
233 if (state.dir_ * head_dy < 0)
235 demerit += state.parameters_.head_encompass_penalty_;
236 convex_head_distances.push_back (0.0);
241 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
242 : state.parameters_.head_encompass_penalty_;
243 hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
248 Real line_y = linear_interpolate (x,
249 attachment_[RIGHT][X_AXIS],
250 attachment_[LEFT][X_AXIS],
251 attachment_[RIGHT][Y_AXIS],
252 attachment_[LEFT][Y_AXIS]);
254 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
258 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
259 Real d = fabs (closest - y);
261 convex_head_distances.push_back (d);
265 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
267 Real stem_dem = state.parameters_.stem_encompass_penalty_;
268 if ((l_edge && state.dir_ == UP)
269 || (r_edge && state.dir_ == DOWN))
275 add_score (demerit, "encompass");
277 if (vsize n = convex_head_distances.size ())
279 Real avg_distance = 0.0;
280 Real min_dist = infinity_f;
282 for (vsize j = 0; j < n; j++)
284 min_dist = min (min_dist, convex_head_distances[j]);
285 avg_distance += convex_head_distances[j];
289 For slurs over 3 or 4 heads, the average distance is not a
295 avg_distance += height_ * fact;
300 TODO: maybe it's better to use (avgdist - mindist)*factor
304 Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
307 = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
309 variance_penalty = max (variance_penalty, 0.0);
310 variance_penalty *= state.parameters_.head_slur_distance_factor_;
312 add_score (variance_penalty, "variance");
317 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
319 for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
321 Drul_array<Offset> attachment = attachment_;
322 Extra_collision_info const &info (state.extra_encompass_infos_[j]);
324 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
327 to prevent numerical inaccuracies in
328 Bezier::get_other_coordinate ().
334 for (LEFT_and_RIGHT (d))
337 We need to check for the bound explicitly, since the
338 slur-ending can be almost vertical, making the Y
339 coordinate a bad approximation of the object-slur
342 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
346 Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
347 item_x.intersect (state.extremes_[d].slur_head_x_extent_);
348 if (!item_x.is_empty ())
350 y = attachment[d][Y_AXIS];
358 Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
360 if (!slur_wid.contains (x))
363 y = curve_.get_other_coordinate (X_AXIS, x);
367 if (info.type_ == ly_symbol2scm ("around"))
368 dist = info.extents_[Y_AXIS].distance (y);
371 Have to score too: the curve enumeration is limited in its
372 shape, and may produce curves which collide anyway.
374 else if (info.type_ == ly_symbol2scm ("inside"))
375 dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
377 programming_error ("unknown avoidance type");
379 dist = max (dist, 0.0);
381 Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
382 state.parameters_.extra_encompass_free_distance_,
385 add_score (penalty, "extra");
390 Slur_configuration::score_edges (Slur_score_state const &state)
393 Offset dz = attachment_[RIGHT]
395 Real slope = dz[Y_AXIS] / dz[X_AXIS];
396 for (LEFT_and_RIGHT (d))
398 Real y = attachment_[d][Y_AXIS];
399 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
401 Real factor = state.parameters_.edge_attraction_factor_;
402 Real demerit = factor * dy;
403 if (state.extremes_[d].stem_
404 && state.extremes_[d].stem_dir_ == state.dir_
405 // TODO - Stem::get_beaming() should be precomputed.
406 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
409 demerit *= exp (state.dir_ * d * slope
410 * state.parameters_.edge_slope_exponent_);
412 string dir_str = d == LEFT ? "L" : "R";
413 add_score (demerit, dir_str + " edge");
418 Slur_configuration::score_slopes (Slur_score_state const &state)
420 Real dy = state.musical_dy_;
421 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
422 Real slur_dy = slur_dz[Y_AXIS];
425 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
426 - state.parameters_.max_slope_), 0.0)
427 * state.parameters_.max_slope_factor_;
429 /* 0.2: account for staffline offset. */
430 Real max_dy = (fabs (dy) + 0.2);
431 if (state.edge_has_beams_)
434 if (!state.is_broken_)
435 demerit += state.parameters_.steeper_slope_factor_
436 * (max (fabs (slur_dy) - max_dy, 0.0));
438 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
439 - state.parameters_.max_slope_), 0.0)
440 * state.parameters_.max_slope_factor_;
443 && sign (slur_dy) != 0
444 && !state.is_broken_)
445 demerit += state.parameters_.non_horizontal_penalty_;
450 && sign (slur_dy) != sign (dy))
451 demerit += state.edge_has_beams_
452 ? state.parameters_.same_slope_penalty_ / 10
453 : state.parameters_.same_slope_penalty_;
455 add_score (demerit, "slope");
458 // This is a temporary hack to see how much we can gain by using a
459 // priority queue on the beams to score.
460 static int score_count = 0;
461 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
463 "count number of slur scores.")
465 return scm_from_int (score_count);
469 Slur_configuration::run_next_scorer (Slur_score_state const &state)
471 switch (next_scorer_todo)
473 case EXTRA_ENCOMPASS:
474 score_extra_encompass (state);
477 score_slopes (state);
483 score_encompass (state);
493 Slur_configuration::done () const
495 return next_scorer_todo >= NUM_SCORERS;
499 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
501 Slur_configuration *conf = new Slur_configuration;
502 conf->attachment_ = offs;
504 conf->next_scorer_todo = INITIAL_SCORE + 1;