2 slur-configuration.cc -- implement Slur_configuration
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "slur-configuration.hh"
17 #include "pointer-group-interface.hh"
19 #include "slur-scoring.hh"
21 #include "staff-symbol-referencer.hh"
22 #include "libc-extension.hh"
25 avoid_staff_line (Slur_score_state const &state,
29 Array<Real> ts = bez.solve_derivative (horiz);
31 /* TODO: handle case of broken slur. */
33 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
34 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
36 Real y = bez.curve_point (ts[0])[Y_AXIS];
38 Grob *staff = state.extremes_[LEFT].staff_;
40 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
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))
50 Direction resolution_dir
51 = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
54 Real newp = my_round (p) + resolution_dir
55 * 5 * state.thickness_;
57 Real dy = (newp - p) * state.staff_space_ / 2.0;
59 bez.control_[1][Y_AXIS] += dy;
60 bez.control_[2][Y_AXIS] += dy;
67 fit_factor (Offset dz_unit, Offset dz_perp,
68 Bezier curve, Direction d, Array<Offset> const &avoid)
70 Real fit_factor = 0.0;
71 Offset x0 = curve.control_[0];
72 curve.translate (-x0);
73 curve.rotate (-dz_unit.arg ());
77 curve_xext.add_point (curve.control_[0][X_AXIS]);
78 curve_xext.add_point (curve.control_[3][X_AXIS]);
80 for (int i = 0; i < avoid.size (); i++)
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]))
88 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
90 fit_factor = max (fit_factor, (p[Y_AXIS] / y));
96 Slur_configuration::generate_curve (Slur_score_state const &state,
98 Array<Offset> const &avoid)
100 Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
102 dz_unit *= 1 / dz.length ();
103 Offset dz_perp = dz_unit * Offset (0, 1);
106 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
108 Real len = dz.length ();
112 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
116 |bez' (0)| < | bez' (.5)|
118 when (control2 - control1) has the same direction as
119 (control3 - control0). */
121 Real max_indent = len / 3.1;
122 indent = min (indent, max_indent);
124 Real a1 = sqr (len) / 3.0;
125 Real a2 = 0.75 * sqr (indent + len / 3.0);
126 Real max_h = a1 - a2;
130 programming_error ("slur indent too small");
135 max_h = sqrt (max_h);
138 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
140 Real x1 = (eccentricity + indent);
141 Real x2 = (eccentricity - indent);
144 curve.control_[0] = attachment_[LEFT];
145 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
147 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
149 curve.control_[3] = attachment_[RIGHT];
151 Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
153 height = max (height, min (height * ff, max_h));
155 curve.control_[0] = attachment_[LEFT];
156 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
158 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
160 curve.control_[3] = attachment_[RIGHT];
162 curve_ = avoid_staff_line (state, curve);
166 Slur_configuration::Slur_configuration ()
173 Slur_configuration::score_encompass (Slur_score_state const &state)
175 Bezier const &bez (curve_);
179 Distances for heads that are between slur and line between
182 Array<Real> convex_head_distances;
183 for (int j = 0; j < state.encompass_infos_.size (); j++)
185 Real x = state.encompass_infos_[j].x_;
187 bool l_edge = j == 0;
188 bool r_edge = j == state.encompass_infos_.size () - 1;
189 bool edge = l_edge || r_edge;
191 if (! (x < attachment_[RIGHT][X_AXIS]
192 && x > attachment_[LEFT][X_AXIS]))
195 Real y = bez.get_other_coordinate (X_AXIS, x);
198 Real head_dy = (y - state.encompass_infos_[j].head_);
199 if (state.dir_ * head_dy < 0)
201 demerit += state.parameters_.head_encompass_penalty_;
202 convex_head_distances.push (0.0);
207 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
208 : state.parameters_.head_encompass_penalty_;
209 hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
214 Real line_y = linear_interpolate (x,
215 attachment_[RIGHT][X_AXIS],
216 attachment_[LEFT][X_AXIS],
217 attachment_[RIGHT][Y_AXIS],
218 attachment_[LEFT][Y_AXIS]);
220 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
224 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
225 Real d = fabs (closest - y);
227 convex_head_distances.push (d);
231 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
233 Real stem_dem = state.parameters_.stem_encompass_penalty_;
234 if ((l_edge && state.dir_ == UP)
235 || (r_edge && state.dir_ == DOWN))
243 ext.add_point (state.encompass_infos_[j].stem_);
244 ext.add_point (state.encompass_infos_[j].head_);
247 demerit += -state.parameters_.closeness_factor_
249 * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
250 / state.encompass_infos_.size ();
254 Real variance_penalty = 0.0;
256 if (convex_head_distances.size ())
258 Real avg_distance = 0.0;
259 Real min_dist = infinity_f;
260 for (int j = 0; j < convex_head_distances.size (); j++)
262 min_dist = min (min_dist, convex_head_distances[j]);
263 avg_distance += convex_head_distances[j];
267 For slurs over 3 or 4 heads, the average distance is not a
270 Real n = convex_head_distances.size ();
274 avg_distance += height_ * fact;
279 TODO: maybe it's better to use (avgdist - mindist)*factor
283 variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
286 = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
288 variance_penalty = max (variance_penalty, 0.0);
289 variance_penalty *= state.parameters_.head_slur_distance_factor_;
292 #if DEBUG_SLUR_SCORING
293 score_card_ += to_string ("C%.2f", demerit);
294 score_card_ += to_string ("D%.2f", variance_penalty);
297 score_ += demerit + variance_penalty;
301 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
304 for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
306 Drul_array<Offset> attachment = attachment_;
307 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
310 to prevent numerical inaccuracies in
311 Bezier::get_other_coordinate ().
320 We need to check for the bound explicitly, since the
321 slur-ending can be almost vertical, making the Y
322 coordinate a bad approximation of the object-slur
325 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
327 && as_item->get_column ()
328 == state.extremes_[d].bound_->get_column ())
329 || state.extra_encompass_infos_[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
331 y = attachment[d][Y_AXIS];
335 while (flip (&d) != LEFT);
339 Real x = state.extra_encompass_infos_[j].extents_[X_AXIS]
340 .linear_combination (state.extra_encompass_infos_[j].idx_);
342 if (!slur_wid.contains (x))
345 y = curve_.get_other_coordinate (X_AXIS, x);
348 Real dist = state.extra_encompass_infos_[j].extents_[Y_AXIS].distance (y);
350 += fabs (max (0.0, (state.parameters_.extra_encompass_free_distance_ - dist)))
351 / state.parameters_.extra_encompass_free_distance_
352 * state.extra_encompass_infos_[j].penalty_;
354 #if DEBUG_SLUR_SCORING
355 score_card_ += to_string ("X%.2f", demerit);
361 Slur_configuration::score_edges (Slur_score_state const &state)
364 Offset dz = attachment_[RIGHT]
366 Real slope = dz[Y_AXIS] / dz[X_AXIS];
369 Real y = attachment_[d][Y_AXIS];
370 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
372 Real factor = state.parameters_.edge_attraction_factor_;
373 Real demerit = factor * dy;
374 if (state.extremes_[d].stem_
375 && state.extremes_[d].stem_dir_ == state.dir_
376 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
379 demerit *= exp (state.dir_ * d * slope
380 * state.parameters_.edge_slope_exponent_);
383 #if DEBUG_SLUR_SCORING
384 score_card_ += to_string ("E%.2f", demerit);
387 while (flip (&d) != LEFT);
391 Slur_configuration ::score_slopes (Slur_score_state const &state)
393 Real dy = state.musical_dy_;
394 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
395 Real slur_dy = slur_dz[Y_AXIS];
398 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
399 - state.parameters_.max_slope_), 0.0)
400 * state.parameters_.max_slope_factor_;
402 /* 0.2: account for staffline offset. */
403 Real max_dy = (fabs (dy) + 0.2);
404 if (state.edge_has_beams_)
407 if (!state.is_broken_)
408 demerit += state.parameters_.steeper_slope_factor_
409 * (max (fabs (slur_dy) -max_dy, 0.0));
411 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
412 - state.parameters_.max_slope_), 0.0)
413 * state.parameters_.max_slope_factor_;
416 && sign (slur_dy) != 0
417 && !state.is_broken_)
418 demerit += state.parameters_.non_horizontal_penalty_;
423 && sign (slur_dy) != sign (dy))
424 demerit += state.edge_has_beams_
425 ? state.parameters_.same_slope_penalty_ / 10
426 : state.parameters_.same_slope_penalty_;
428 #if DEBUG_SLUR_SCORING
429 score_card_ += to_string ("S%.2f", demerit);
435 Slur_configuration::score (Slur_score_state const &state)
437 score_extra_encompass (state);
438 score_slopes (state);
440 score_encompass (state);