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 distance = fabs (my_round (p) - p); // in halfspaces
53 if (distance < 4 * state.thickness_
54 && (int) fabs (my_round (p))
55 <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
56 && (int (fabs (my_round (p))) % 2
57 != Staff_symbol_referencer::line_count (staff) % 2))
59 Direction resolution_dir
60 = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
63 Real newp = my_round (p) + resolution_dir
64 * 5 * state.thickness_;
66 Real dy = (newp - p) * state.staff_space_ / 2.0;
68 bez.control_[1][Y_AXIS] += dy;
69 bez.control_[2][Y_AXIS] += dy;
76 fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
77 Bezier curve, Direction d, vector<Offset> const &avoid)
79 Real fit_factor = 0.0;
80 Offset x0 = curve.control_[0];
81 curve.translate (-x0);
82 curve.rotate (-dz_unit.arg ());
86 curve_xext.add_point (curve.control_[0][X_AXIS]);
87 curve_xext.add_point (curve.control_[3][X_AXIS]);
89 for (vsize i = 0; i < avoid.size (); i++)
91 Offset z = (avoid[i] - x0);
92 Offset p (dot_product (z, dz_unit),
93 d * dot_product (z, dz_perp));
95 bool close_to_edge = false;
96 for (LEFT_and_RIGHT (d))
97 close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
103 Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
104 pext.intersect (curve_xext);
106 if (pext.is_empty () || pext.length () <= 1.999 * eps)
109 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
111 fit_factor = max (fit_factor, (p[Y_AXIS] / y));
117 Slur_configuration::generate_curve (Slur_score_state const &state,
118 Real r_0, Real h_inf,
119 vector<Offset> const &avoid)
121 Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
123 dz_unit *= 1 / dz.length ();
124 Offset dz_perp = dz_unit * Offset (0, 1);
127 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
129 Real len = dz.length ();
133 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
137 |bez' (0)| < | bez' (.5)|
139 when (control2 - control1) has the same direction as
140 (control3 - control0). */
142 Real max_indent = len / 3.1;
143 indent = min (indent, max_indent);
145 Real a1 = sqr (len) / 3.0;
146 Real a2 = 0.75 * sqr (indent + len / 3.0);
147 Real max_h = a1 - a2;
151 programming_error ("slur indent too small");
155 max_h = sqrt (max_h);
157 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
159 Real x1 = (eccentricity + indent);
160 Real x2 = (eccentricity - indent);
163 curve.control_[0] = attachment_[LEFT];
164 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
166 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
168 curve.control_[3] = attachment_[RIGHT];
170 Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
171 curve, state.dir_, avoid);
173 height = max (height, min (height * ff, max_h));
175 curve.control_[0] = attachment_[LEFT];
176 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
178 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
180 curve.control_[3] = attachment_[RIGHT];
182 curve_ = avoid_staff_line (state, curve);
186 Slur_configuration::Slur_configuration ()
193 Slur_configuration::add_score (Real s, string desc)
197 programming_error ("Negative demerits found for slur. Ignoring");
203 if (score_card_.length () > 0)
205 score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
211 Slur_configuration::score_encompass (Slur_score_state const &state)
213 Bezier const &bez (curve_);
217 Distances for heads that are between slur and line between
220 vector<Real> convex_head_distances;
221 for (vsize j = 0; j < state.encompass_infos_.size (); j++)
223 Real x = state.encompass_infos_[j].x_;
225 bool l_edge = j == 0;
226 bool r_edge = j == state.encompass_infos_.size () - 1;
227 bool edge = l_edge || r_edge;
229 if (! (x < attachment_[RIGHT][X_AXIS]
230 && x > attachment_[LEFT][X_AXIS]))
233 Real y = bez.get_other_coordinate (X_AXIS, x);
236 Real head_dy = (y - state.encompass_infos_[j].head_);
237 if (state.dir_ * head_dy < 0)
239 demerit += state.parameters_.head_encompass_penalty_;
240 convex_head_distances.push_back (0.0);
245 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
246 : state.parameters_.head_encompass_penalty_;
247 hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
252 Real line_y = linear_interpolate (x,
253 attachment_[RIGHT][X_AXIS],
254 attachment_[LEFT][X_AXIS],
255 attachment_[RIGHT][Y_AXIS],
256 attachment_[LEFT][Y_AXIS]);
258 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
262 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
263 Real d = fabs (closest - y);
265 convex_head_distances.push_back (d);
269 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
271 Real stem_dem = state.parameters_.stem_encompass_penalty_;
272 if ((l_edge && state.dir_ == UP)
273 || (r_edge && state.dir_ == DOWN))
279 add_score (demerit, "encompass");
281 if (convex_head_distances.size ())
283 Real avg_distance = 0.0;
284 Real min_dist = infinity_f;
285 for (vsize j = 0; j < convex_head_distances.size (); j++)
287 min_dist = min (min_dist, convex_head_distances[j]);
288 avg_distance += convex_head_distances[j];
292 For slurs over 3 or 4 heads, the average distance is not a
295 Real n = convex_head_distances.size ();
299 avg_distance += height_ * fact;
304 TODO: maybe it's better to use (avgdist - mindist)*factor
308 Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
311 = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
313 variance_penalty = max (variance_penalty, 0.0);
314 variance_penalty *= state.parameters_.head_slur_distance_factor_;
316 add_score (variance_penalty, "variance");
321 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
323 for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
325 Drul_array<Offset> attachment = attachment_;
326 Extra_collision_info const &info (state.extra_encompass_infos_[j]);
328 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
331 to prevent numerical inaccuracies in
332 Bezier::get_other_coordinate ().
338 for (LEFT_and_RIGHT (d))
341 We need to check for the bound explicitly, since the
342 slur-ending can be almost vertical, making the Y
343 coordinate a bad approximation of the object-slur
346 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
350 Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
351 item_x.intersect (state.extremes_[d].slur_head_x_extent_);
352 if (!item_x.is_empty ())
354 y = attachment[d][Y_AXIS];
362 Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
364 if (!slur_wid.contains (x))
367 y = curve_.get_other_coordinate (X_AXIS, x);
371 if (info.type_ == ly_symbol2scm ("around"))
372 dist = info.extents_[Y_AXIS].distance (y);
375 Have to score too: the curve enumeration is limited in its
376 shape, and may produce curves which collide anyway.
378 else if (info.type_ == ly_symbol2scm ("inside"))
379 dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
381 programming_error ("unknown avoidance type");
383 dist = max (dist, 0.0);
385 Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
386 state.parameters_.extra_encompass_free_distance_,
389 add_score (penalty, "extra");
394 Slur_configuration::score_edges (Slur_score_state const &state)
397 Offset dz = attachment_[RIGHT]
399 Real slope = dz[Y_AXIS] / dz[X_AXIS];
400 for (LEFT_and_RIGHT (d))
402 Real y = attachment_[d][Y_AXIS];
403 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
405 Real factor = state.parameters_.edge_attraction_factor_;
406 Real demerit = factor * dy;
407 if (state.extremes_[d].stem_
408 && state.extremes_[d].stem_dir_ == state.dir_
409 // TODO - Stem::get_beaming() should be precomputed.
410 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
413 demerit *= exp (state.dir_ * d * slope
414 * state.parameters_.edge_slope_exponent_);
416 string dir_str = d == LEFT ? "L" : "R";
417 add_score (demerit, dir_str + " edge");
422 Slur_configuration::score_slopes (Slur_score_state const &state)
424 Real dy = state.musical_dy_;
425 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
426 Real slur_dy = slur_dz[Y_AXIS];
429 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
430 - state.parameters_.max_slope_), 0.0)
431 * state.parameters_.max_slope_factor_;
433 /* 0.2: account for staffline offset. */
434 Real max_dy = (fabs (dy) + 0.2);
435 if (state.edge_has_beams_)
438 if (!state.is_broken_)
439 demerit += state.parameters_.steeper_slope_factor_
440 * (max (fabs (slur_dy) - max_dy, 0.0));
442 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
443 - state.parameters_.max_slope_), 0.0)
444 * state.parameters_.max_slope_factor_;
447 && sign (slur_dy) != 0
448 && !state.is_broken_)
449 demerit += state.parameters_.non_horizontal_penalty_;
454 && sign (slur_dy) != sign (dy))
455 demerit += state.edge_has_beams_
456 ? state.parameters_.same_slope_penalty_ / 10
457 : state.parameters_.same_slope_penalty_;
459 add_score (demerit, "slope");
462 // This is a temporary hack to see how much we can gain by using a
463 // priority queue on the beams to score.
464 static int score_count = 0;
465 LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
467 "count number of slur scores.")
469 return scm_from_int (score_count);
473 Slur_configuration::run_next_scorer (Slur_score_state const &state)
475 switch (next_scorer_todo)
477 case EXTRA_ENCOMPASS:
478 score_extra_encompass (state);
481 score_slopes (state);
487 score_encompass (state);
497 Slur_configuration::done () const
499 return next_scorer_todo >= NUM_SCORERS;
503 Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
505 Slur_configuration *conf = new Slur_configuration;
506 conf->attachment_ = offs;
508 conf->next_scorer_todo = INITIAL_SCORE + 1;