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 "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]);
91 fit_factor = fit_factor >? (p[Y_AXIS] / y);
98 Slur_configuration::generate_curve (Slur_score_state const &state,
101 Link_array<Grob> encompasses = state.columns_;
104 for (int i = 0; i < encompasses.size (); i++)
106 if (state.extremes_[LEFT].note_column_ == encompasses[i]
107 || state.extremes_[RIGHT].note_column_ == encompasses[i])
110 Encompass_info inf (state.get_encompass_info (encompasses[i]));
111 Real y = state.dir_ * ((state.dir_ * inf.head_) >? (state.dir_ *inf.stem_));
113 avoid.push (Offset (inf.x_, y + state.dir_ * state.parameters_.free_head_distance_));
116 Link_array<Grob> extra_encompasses
117 = extract_grob_array (state.slur_, ly_symbol2scm ("encompass-objects"));
118 for (int i = 0; i < extra_encompasses.size (); i++)
119 if (Slur::has_interface (extra_encompasses[i]))
121 Grob *small_slur = extra_encompasses[i];
122 Bezier b = Slur::get_curve (small_slur);
124 Offset z = b.curve_point (0.5);
125 z += Offset (small_slur->relative_coordinate (state.common_[X_AXIS], X_AXIS),
126 small_slur->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
128 z[Y_AXIS] += state.dir_ * state.parameters_.free_slur_distance_;
132 Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
134 dz_unit *= 1 / dz.length ();
135 Offset dz_perp = dz_unit * Offset (0, 1);
138 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
140 Real len = dz.length ();
144 len^2 > 4h^2 + 3 (i + 1/3len)^2 - 1/3 len^2
148 |bez' (0)| < | bez' (.5)|
150 when (control2 - control1) has the same direction as
151 (control3 - control0). */
153 Real max_indent = len / 3.1;
154 indent = indent <? max_indent;
156 Real a1 = sqr (len) / 3.0;
157 Real a2 = 0.75 * sqr (indent + len / 3.0);
158 Real max_h = a1 - a2;
162 programming_error ("Slur indent too small.");
167 max_h = sqrt (max_h);
170 Real excentricity = robust_scm2double (state.slur_->get_property ("excentricity"), 0);
172 Real x1 = (excentricity + indent);
173 Real x2 = (excentricity - indent);
176 curve.control_[0] = attachment_[LEFT];
177 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
179 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
181 curve.control_[3] = attachment_[RIGHT];
183 Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
185 height = height >? ((height * ff) <? max_h);
187 curve.control_[0] = attachment_[LEFT];
188 curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
190 curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
192 curve.control_[3] = attachment_[RIGHT];
194 curve_ = avoid_staff_line (state, curve);
198 Slur_configuration::Slur_configuration ()
206 Slur_configuration::score_encompass (Slur_score_state const &state)
208 Bezier const &bez (curve_);
212 Distances for heads that are between slur and line between
215 Array<Real> convex_head_distances;
216 for (int j = 0; j < state.encompass_infos_.size (); j++)
218 Real x = state.encompass_infos_[j].x_;
220 bool l_edge = j == 0;
221 bool r_edge = j == state.encompass_infos_.size () - 1;
222 bool edge = l_edge || r_edge;
224 if (! (x < attachment_[RIGHT][X_AXIS]
225 && x > attachment_[LEFT][X_AXIS]))
228 Real y = bez.get_other_coordinate (X_AXIS, x);
231 Real head_dy = (y - state.encompass_infos_[j].head_);
232 if (state.dir_ * head_dy < 0)
234 demerit += state.parameters_.head_encompass_penalty_;
235 convex_head_distances.push (0.0);
240 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
241 : state.parameters_.head_encompass_penalty_;
242 hd = (hd >? 0)<? state.parameters_.head_encompass_penalty_;
247 Real line_y = linear_interpolate (x,
248 attachment_[RIGHT][X_AXIS],
249 attachment_[LEFT][X_AXIS],
250 attachment_[RIGHT][Y_AXIS],
251 attachment_[LEFT][Y_AXIS]);
253 if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
257 = state.dir_ * (state.dir_ * state.encompass_infos_[j].get_point (state.dir_)
258 >? state.dir_ *line_y);
259 Real d = fabs (closest - y);
261 convex_head_distances.push (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))
277 ext.add_point (state.encompass_infos_[j].stem_);
278 ext.add_point (state.encompass_infos_[j].head_);
281 demerit += -state.parameters_.closeness_factor_
283 * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_))
285 / state.encompass_infos_.size ();
289 Real variance_penalty = 0.0;
291 if (convex_head_distances.size ())
293 Real avg_distance = 0.0;
294 Real min_dist = infinity_f;
295 for (int j = 0; j < convex_head_distances.size (); j++)
297 min_dist = min_dist <? convex_head_distances[j];
298 avg_distance += convex_head_distances[j];
302 For slurs over 3 or 4 heads, the average distance is not a
305 Real n = convex_head_distances.size ();
309 avg_distance += height_ * fact;
314 TODO: maybe it's better to use (avgdist - mindist)*factor
318 variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
321 = (avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0)
324 variance_penalty = variance_penalty >? 0.0;
325 variance_penalty *= state.parameters_.head_slur_distance_factor_;
328 #if DEBUG_SLUR_SCORING
329 score_card_ += to_string ("C%.2f", demerit);
330 score_card_ += to_string ("D%.2f", variance_penalty);
333 score_ += demerit + variance_penalty;
337 Slur_configuration::score_extra_encompass (Slur_score_state const &state)
340 for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
342 Drul_array<Offset> attachment = attachment_;
343 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
346 to prevent numerical inaccuracies in
347 Bezier::get_other_coordinate ().
356 We need to check for the bound explicitly, since the
357 slur-ending can be almost vertical, making the Y
358 coordinate a bad approximation of the object-slur
361 Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
363 && as_item->get_column ()
364 == state.extremes_[d] .bound_->get_column ())
365 || state.extra_encompass_infos_[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
367 y = attachment[d][Y_AXIS];
371 while (flip (&d) != LEFT);
375 Real x = state.extra_encompass_infos_[j].extents_[X_AXIS]
376 .linear_combination (state.extra_encompass_infos_[j].idx_);
378 if (!slur_wid.contains (x))
381 y = curve_.get_other_coordinate (X_AXIS, x);
384 Real dist = state.extra_encompass_infos_[j].extents_[Y_AXIS].distance (y);
386 += fabs (0 >? (state.parameters_.extra_encompass_free_distance_ - dist))
387 / state.parameters_.extra_encompass_free_distance_
388 * state.extra_encompass_infos_[j].penalty_;
390 #if DEBUG_SLUR_SCORING
391 score_card_ += to_string ("X%.2f", demerit);
397 Slur_configuration::score_edges (Slur_score_state const &state)
400 Offset dz = attachment_[RIGHT]
402 Real slope = dz[Y_AXIS] / dz[X_AXIS];
405 Real y = attachment_[d][Y_AXIS];
406 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
408 Real factor = state.parameters_.edge_attraction_factor_;
409 Real demerit = factor * dy;
410 if (state.extremes_[d].stem_
411 && state.extremes_[d].stem_dir_ == state.dir_
412 && !Stem::get_beaming (state.extremes_[d].stem_, -d))
415 demerit *= exp (state.dir_ * d * slope
416 * state.parameters_.edge_slope_exponent_);
419 #if DEBUG_SLUR_SCORING
420 score_card_ += to_string ("E%.2f", demerit);
423 while (flip (&d) != LEFT);
427 Slur_configuration ::score_slopes (Slur_score_state const &state)
429 Real dy = state.musical_dy_;
430 Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
431 Real slur_dy = slur_dz[Y_AXIS];
434 demerit += ((fabs (slur_dy / slur_dz[X_AXIS])
435 - state.parameters_.max_slope_) >? 0)
436 * state.parameters_.max_slope_factor_;
438 /* 0.2: account for staffline offset. */
439 Real max_dy = (fabs (dy) + 0.2);
440 if (state.edge_has_beams_)
443 if (!state.is_broken_)
444 demerit += state.parameters_.steeper_slope_factor_
445 * ((fabs (slur_dy) -max_dy) >? 0);
447 demerit += ((fabs (slur_dy / slur_dz[X_AXIS])
448 - state.parameters_.max_slope_) >? 0)
449 * state.parameters_.max_slope_factor_;
452 && sign (slur_dy) != 0
453 && !state.is_broken_)
454 demerit += state.parameters_.non_horizontal_penalty_;
459 && sign (slur_dy) != sign (dy))
460 demerit += state.edge_has_beams_
461 ? state.parameters_.same_slope_penalty_ / 10
462 : state.parameters_.same_slope_penalty_;
464 #if DEBUG_SLUR_SCORING
465 score_card_ += to_string ("S%.2f", demerit);
471 Slur_configuration::score (Slur_score_state const &state)
473 score_extra_encompass (state);
474 score_slopes (state);
476 score_encompass (state);