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"
16 #include "pointer-group-interface.hh"
18 #include "slur-scoring.hh"
20 #include "staff-symbol-referencer.hh"
21 #include "libc-extension.hh"
24 avoid_staff_line (Slur_score_state const &state,
28 Array<Real> ts = bez.solve_derivative (horiz);
30 /* TODO: handle case of broken slur. */
32 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
33 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
35 Real y = bez.curve_point (ts[0])[Y_AXIS];
37 Grob *staff = state.extremes_[LEFT].staff_;
39 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
42 Real distance = fabs (my_round (p) - p); // in halfspaces
43 if (distance < 4 * state.thickness_
44 && (int) fabs (my_round (p))
45 <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
46 && (int (fabs (my_round (p))) % 2
47 != Staff_symbol_referencer::line_count (staff) % 2))
49 Direction resolution_dir
50 = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
53 Real newp = my_round (p) + resolution_dir
54 * 5 * state.thickness_;
56 Real dy = (newp - p) * state.staff_space_ / 2.0;
58 bez.control_[1][Y_AXIS] += dy;
59 bez.control_[2][Y_AXIS] += dy;
66 fit_factor (Offset dz_unit, Offset dz_perp,
67 Bezier curve, Direction d, Array<Offset> const &avoid)
69 Real fit_factor = 0.0;
70 Offset x0 = curve.control_[0];
71 curve.translate (-x0);
72 curve.rotate (-dz_unit.arg ());
76 curve_xext.add_point (curve.control_[0][X_AXIS]);
77 curve_xext.add_point (curve.control_[3][X_AXIS]);
79 for (int i = 0; i < avoid.size (); i++)
81 Offset z = (avoid[i] - x0);
82 Offset p (dot_product (z, dz_unit),
83 d * dot_product (z, dz_perp));
84 if (!curve_xext.contains (p[X_AXIS]))
87 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
89 fit_factor = max (fit_factor, (p[Y_AXIS] / y));
95 Slur_configuration::generate_curve (Slur_score_state const &state,
97 Array<Offset> const &avoid)
99 Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
101 dz_unit *= 1 / dz.length ();
102 Offset dz_perp = dz_unit * Offset (0, 1);
105 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
107 Real len = dz.length ();
111 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
115 |bez' (0)| < | bez' (.5)|
117 when (control2 - control1) has the same direction as
118 (control3 - control0). */
120 Real max_indent = len / 3.1;
121 indent = min (indent, max_indent);
123 Real a1 = sqr (len) / 3.0;
124 Real a2 = 0.75 * sqr (indent + len / 3.0);
125 Real max_h = a1 - a2;
129 programming_error ("slur indent too small");
133 max_h = sqrt (max_h);
135 Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
137 Real x1 = (eccentricity + indent);
138 Real x2 = (eccentricity - indent);
141 curve.control_[0] = attachment_[LEFT];
142 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
144 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
146 curve.control_[3] = attachment_[RIGHT];
148 Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
150 height = max (height, min (height * ff, max_h));
152 curve.control_[0] = attachment_[LEFT];
153 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
155 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
157 curve.control_[3] = attachment_[RIGHT];
159 curve_ = avoid_staff_line (state, curve);
163 Slur_configuration::Slur_configuration ()
170 Slur_configuration::score_encompass (Slur_score_state const &state)
172 Bezier const &bez (curve_);
176 Distances for heads that are between slur and line between
179 Array<Real> convex_head_distances;
180 for (int j = 0; j < state.encompass_infos_.size (); j++)
182 Real x = state.encompass_infos_[j].x_;
184 bool l_edge = j == 0;
185 bool r_edge = j == state.encompass_infos_.size () - 1;
186 bool edge = l_edge || r_edge;
188 if (! (x < attachment_[RIGHT][X_AXIS]
189 && x > attachment_[LEFT][X_AXIS]))
192 Real y = bez.get_other_coordinate (X_AXIS, x);
195 Real head_dy = (y - state.encompass_infos_[j].head_);
196 if (state.dir_ * head_dy < 0)
198 demerit += state.parameters_.head_encompass_penalty_;
199 convex_head_distances.push (0.0);
204 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
205 : state.parameters_.head_encompass_penalty_;
206 hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
211 Real line_y = linear_interpolate (x,
212 attachment_[RIGHT][X_AXIS],
213 attachment_[LEFT][X_AXIS],
214 attachment_[RIGHT][Y_AXIS],
215 attachment_[LEFT][Y_AXIS]);
217 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
221 = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
222 Real d = fabs (closest - y);
224 convex_head_distances.push (d);
228 if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
230 Real stem_dem = state.parameters_.stem_encompass_penalty_;
231 if ((l_edge && state.dir_ == UP)
232 || (r_edge && state.dir_ == DOWN))
240 ext.add_point (state.encompass_infos_[j].stem_);
241 ext.add_point (state.encompass_infos_[j].head_);
244 demerit += -state.parameters_.closeness_factor_
246 * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
247 / state.encompass_infos_.size ();
251 Real variance_penalty = 0.0;
253 if (convex_head_distances.size ())
255 Real avg_distance = 0.0;
256 Real min_dist = infinity_f;
257 for (int j = 0; j < convex_head_distances.size (); j++)
259 min_dist = min (min_dist, convex_head_distances[j]);
260 avg_distance += convex_head_distances[j];
264 For slurs over 3 or 4 heads, the average distance is not a
267 Real n = convex_head_distances.size ();
271 avg_distance += height_ * fact;
276 TODO: maybe it's better to use (avgdist - mindist)*factor
280 variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
283 = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
285 variance_penalty = max (variance_penalty, 0.0);
286 variance_penalty *= state.parameters_.head_slur_distance_factor_;
289 #if DEBUG_SLUR_SCORING
290 score_card_ += to_string ("C%.2f", demerit);
291 score_card_ += to_string ("D%.2f", variance_penalty);
294 score_ += demerit + variance_penalty;
298 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
301 for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
303 Drul_array<Offset> attachment = attachment_;
304 Extra_collision_info const &info (state.extra_encompass_infos_[j]);
306 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
309 to prevent numerical inaccuracies in
310 Bezier::get_other_coordinate ().
319 We need to check for the bound explicitly, since the
320 slur-ending can be almost vertical, making the Y
321 coordinate a bad approximation of the object-slur
324 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
328 Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
329 item_x.intersect (state.extremes_[d].slur_head_x_extent_);
330 if (!item_x.is_empty ())
332 y = attachment[d][Y_AXIS];
337 while (flip (&d) != LEFT);
341 Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
343 if (!slur_wid.contains (x))
346 y = curve_.get_other_coordinate (X_AXIS, x);
350 if (info.type_ == ly_symbol2scm ("around"))
351 dist = info.extents_[Y_AXIS].distance (y);
354 Have to score too: the curve enumeration is limited in its
355 shape, and may produce curves which collide anyway.
357 else if (info.type_ == ly_symbol2scm ("inside"))
358 dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
360 programming_error ("unknown avoidance type");
364 = (1.0 / (max (dist, 0.0) + epsilon * state.parameters_.extra_encompass_free_distance_));
366 = 1.0 / ((1 + epsilon) * state.parameters_.extra_encompass_free_distance_);
369 += max (info.penalty_ * (factor - threshold), 0.0);
371 #if DEBUG_SLUR_SCORING
372 score_card_ += to_string ("X%.2f", demerit);
379 Slur_configuration::score_edges (Slur_score_state const &state)
382 Offset dz = attachment_[RIGHT]
384 Real slope = dz[Y_AXIS] / dz[X_AXIS];
387 Real y = attachment_[d][Y_AXIS];
388 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
390 Real factor = state.parameters_.edge_attraction_factor_;
391 Real demerit = factor * dy;
392 if (state.extremes_[d].stem_
393 && state.extremes_[d].stem_dir_ == state.dir_
394 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
397 demerit *= exp (state.dir_ * d * slope
398 * state.parameters_.edge_slope_exponent_);
401 #if DEBUG_SLUR_SCORING
402 score_card_ += to_string ("E%.2f", demerit);
405 while (flip (&d) != LEFT);
409 Slur_configuration ::score_slopes (Slur_score_state const &state)
411 Real dy = state.musical_dy_;
412 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
413 Real slur_dy = slur_dz[Y_AXIS];
416 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
417 - state.parameters_.max_slope_), 0.0)
418 * state.parameters_.max_slope_factor_;
420 /* 0.2: account for staffline offset. */
421 Real max_dy = (fabs (dy) + 0.2);
422 if (state.edge_has_beams_)
425 if (!state.is_broken_)
426 demerit += state.parameters_.steeper_slope_factor_
427 * (max (fabs (slur_dy) -max_dy, 0.0));
429 demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
430 - state.parameters_.max_slope_), 0.0)
431 * state.parameters_.max_slope_factor_;
434 && sign (slur_dy) != 0
435 && !state.is_broken_)
436 demerit += state.parameters_.non_horizontal_penalty_;
441 && sign (slur_dy) != sign (dy))
442 demerit += state.edge_has_beams_
443 ? state.parameters_.same_slope_penalty_ / 10
444 : state.parameters_.same_slope_penalty_;
446 #if DEBUG_SLUR_SCORING
447 score_card_ += to_string ("S%.2f", demerit);
453 Slur_configuration::score (Slur_score_state const &state)
455 score_extra_encompass (state);
456 score_slopes (state);
458 score_encompass (state);