2 slur-quanting.cc -- Score based slur formatting
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 #include "accidental-interface.hh"
14 #include "directional-element-interface.hh"
15 #include "group-interface.hh"
16 #include "libc-extension.hh"
17 #include "lily-guile.hh"
19 #include "note-column.hh"
20 #include "output-def.hh"
24 #include "staff-symbol-referencer.hh"
25 #include "staff-symbol.hh"
28 #include "paper-column.hh"
33 - curve around flag for y coordinate
35 - this file is a big mess, clean it up
37 - short-cut: try a smaller region first.
39 - handle non-visible stems better.
41 - try to prune number of scoring criteria
43 - take encompass-objects more into account when determining
46 - calculate encompass scoring directly after determining slur shape.
54 Drul_array<Offset> attachment_;
58 #if DEBUG_SLUR_QUANTING
68 struct Slur_score_parameters
71 Real head_encompass_penalty_;
72 Real stem_encompass_penalty_;
73 Real closeness_factor_;
74 Real edge_attraction_factor_;
75 Real same_slope_penalty_;
76 Real steeper_slope_factor_;
77 Real non_horizontal_penalty_;
79 Real max_slope_factor_;
80 Real extra_object_collision_;
81 Real accidental_collision_;
82 Real free_slur_distance_;
83 Real free_head_distance_;
84 Real extra_encompass_free_distance_;
85 Real edge_slope_exponent_;
86 Real head_slur_distance_max_ratio_;
87 Real head_slur_distance_factor_;
92 struct Extra_collision_info
99 Extra_collision_info (Grob *g, Real idx, Interval x, Interval y, Real p)
102 extents_[X_AXIS] = x;
103 extents_[Y_AXIS] = y;
107 Extra_collision_info ()
116 struct Encompass_info
127 Real get_point (Direction dir)
145 Interval slur_head_extent_;
160 struct Slur_score_state
163 Grob *common_[NO_AXES];
166 Link_array<Grob> columns_;
167 Array<Encompass_info> encompass_infos_;
169 Slur_score_parameters parameters_;
170 Drul_array<Bound_info> extremes_;
171 Drul_array<Offset> base_attachments_;
172 Array<Slur_score> *scores_;
180 Slur_score_state::Slur_score_state()
190 Slur_score_state::~Slur_score_state ()
195 static void score_extra_encompass (Slur_score_state const&);
196 static void score_slopes (Slur_score_state const&);
197 static void score_edges (Slur_score_state const&);
198 static void score_encompass (Slur_score_state const&);
199 static Bezier avoid_staff_line (Slur_score_state const&,
201 static Encompass_info get_encompass_info (Slur_score_state const&, Grob *col);
202 static Bezier get_bezier (Slur_score_state const&,
204 Real r_0, Real h_inf);
205 static Direction get_default_dir (Grob *me);
207 static void set_end_points (Grob *);
208 static Real broken_trend_y (Slur_score_state const&, Direction dir);
209 static Drul_array<Bound_info> get_bound_info (Slur_score_state const&);
211 static void generate_curves (Slur_score_state const&);
212 static Array<Slur_score> *enumerate_attachments (Slur_score_state const&,
213 Drul_array<Real> end_ys);
214 static Drul_array<Offset> get_base_attachments(Slur_score_state const&);
215 static Drul_array<Real> get_y_attachment_range(Slur_score_state const&);
219 get_detail (SCM alist, SCM sym)
221 SCM entry = scm_assq (sym, alist);
222 return robust_scm2double (scm_is_pair (entry)
229 init_score_param (Grob *me,
230 Slur_score_parameters *score_param)
232 SCM details = me->get_property ("slur-details");
234 score_param->region_size_
235 = (int) get_detail (details, ly_symbol2scm ("region-size"));
236 score_param->head_encompass_penalty_
237 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
238 score_param->stem_encompass_penalty_
239 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
240 score_param->closeness_factor_
241 = get_detail (details, ly_symbol2scm ("closeness-factor"));
242 score_param->edge_attraction_factor_
243 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
244 score_param->same_slope_penalty_
245 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
246 score_param->steeper_slope_factor_
247 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
248 score_param->non_horizontal_penalty_
249 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
250 score_param->max_slope_
251 = get_detail (details, ly_symbol2scm ("max-slope"));
252 score_param->max_slope_factor_
253 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
254 score_param->free_head_distance_
255 = get_detail (details, ly_symbol2scm ("free-head-distance"));
256 score_param->extra_object_collision_
257 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
258 score_param->accidental_collision_
259 = get_detail (details, ly_symbol2scm ("accidental-collision"));
260 score_param->extra_encompass_free_distance_
261 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
262 score_param->head_slur_distance_factor_
263 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
264 score_param->head_slur_distance_max_ratio_
265 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
266 score_param->free_slur_distance_
267 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
268 score_param->edge_slope_exponent_
269 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
274 /* HDIR indicates which side (left or right) we are processing here. */
276 broken_trend_y (Slur_score_state const &state, Direction hdir)
278 /* A broken slur should maintain the same vertical trend
279 the unbroken slur would have had. */
281 if (Spanner *mother = dynamic_cast<Spanner*> (state.slur_->original_))
283 int k = broken_spanner_index (state.slur_);
285 if (j < 0 || j >= mother->broken_intos_.size ())
288 Grob *neighbor = mother->broken_intos_[j];
290 neighbor->set_property ("direction", scm_from_int (state.dir_));
292 Spanner *common_mother
293 = dynamic_cast<Spanner*> (state.common_[Y_AXIS]->original_);
295 = broken_spanner_index (dynamic_cast<Spanner*> (state.common_[Y_AXIS]));
296 int common_j = common_k + hdir;
298 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
301 Grob *common_next_system = common_mother->broken_intos_[common_j];
302 Link_array<Grob> neighbor_cols
303 = Pointer_group_interface__extract_grobs (neighbor, (Grob *)0,
307 = (hdir == RIGHT) ? neighbor_cols[0] : neighbor_cols.top ();
308 Grob *neighbor_common
309 = common_next_system->common_refpoint (neighbor_col, Y_AXIS);
311 Direction vdir = state.dir_;
313 = neighbor_col->extent (neighbor_common, Y_AXIS)
314 .linear_combination (int (vdir))
315 - common_next_system->relative_coordinate (neighbor_common, Y_AXIS);
317 Grob *extreme_col = (hdir == RIGHT) ? state.columns_.top () : state.columns_[0];
318 Real y = extreme_col->extent (state.common_[Y_AXIS], Y_AXIS)
319 .linear_combination (int ((state.columns_.size () == 1) ? CENTER : vdir));
320 by = (y*neighbor_cols.size () + neighbor_y*state.columns_.size ()) /
321 (state.columns_.size () + neighbor_cols.size ());
327 get_encompass_info (Slur_score_state const &state,
330 Grob *stem = unsmob_grob (col->get_property ("stem"));
335 programming_error ("No stem for note column?");
336 ei.x_ = col->relative_coordinate (state.common_[X_AXIS], X_AXIS);
337 ei.head_ = ei.stem_ = col->extent (state.common_[Y_AXIS],
341 Direction stem_dir = get_grob_direction (stem);
343 if (Grob *head = Note_column::first_head (col))
344 ei.x_ = head->extent (state.common_[X_AXIS], X_AXIS).center ();
346 ei.x_ = col->extent (state.common_[X_AXIS], X_AXIS).center ();
348 Grob *h = Stem::extremal_heads (stem)[Direction (state.dir_)];
351 ei.head_ = ei.stem_ = col->extent (state.common_[Y_AXIS], Y_AXIS)[state.dir_];
355 ei.head_ = h->extent (state.common_[Y_AXIS], Y_AXIS)[state.dir_];
357 if ((stem_dir == state.dir_)
358 && !stem->extent (stem, Y_AXIS).is_empty ())
360 ei.stem_ = stem->extent (state.common_[Y_AXIS], Y_AXIS)[state.dir_];
361 if (Grob *b = Stem::get_beam (stem))
362 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
364 Interval x = stem->extent (state.common_[X_AXIS], X_AXIS);
365 ei.x_ = x.is_empty ()
366 ? stem->relative_coordinate (state.common_[X_AXIS], X_AXIS)
377 get_default_dir (Grob*me)
379 Link_array<Grob> encompasses
380 = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "note-columns");
383 for (int i= 0; i < encompasses.size (); i ++)
385 if (Note_column::dir (encompasses[i]) < 0)
396 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1);
398 Slur::after_line_breaking (SCM smob)
400 Spanner *me = dynamic_cast<Spanner*> (unsmob_grob (smob));
401 if (!scm_ilength (me->get_property ("note-columns")))
404 return SCM_UNSPECIFIED;
407 if (!get_grob_direction (me))
408 set_grob_direction (me, get_default_dir (me));
410 if (scm_ilength (me->get_property ("control-points")) < 4)
413 return SCM_UNSPECIFIED;
416 Drul_array<Bound_info>
417 get_bound_info (Slur_score_state const &state)
419 Drul_array<Bound_info> extremes;
422 Direction dir = state.dir_;
426 extremes[d].bound_ = state.slur_->get_bound (d);
427 if (Note_column::has_interface (extremes[d].bound_))
429 extremes[d].note_column_ = extremes[d].bound_;
430 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
431 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
432 extremes[d].stem_extent_[X_AXIS]
433 = extremes[d].stem_->extent (state.common_[X_AXIS], X_AXIS);
434 extremes[d].stem_extent_[Y_AXIS]
435 = extremes[d].stem_->extent (state.common_[Y_AXIS], Y_AXIS);
436 extremes[d].slur_head_
437 = Stem::extremal_heads (extremes[d].stem_)[dir];
438 if (!extremes[d].slur_head_
439 && Note_column::has_rests (extremes[d].bound_))
441 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
444 if (extremes[d].slur_head_)
445 extremes[d].slur_head_extent_
446 = extremes[d].slur_head_->extent (state.common_[X_AXIS], X_AXIS);
448 extremes[d].staff_ = Staff_symbol_referencer
449 ::get_staff_symbol (extremes[d].stem_);
450 extremes[d].staff_space_ = Staff_symbol_referencer
451 ::staff_space (extremes[d].stem_);
455 right side anticipates on the next note.
457 extremes[d].neighbor_y_ = broken_trend_y (state, d);
459 while (flip (&d) != RIGHT);
464 fill_scoring_state (Grob *me, Slur_score_state *state_ptr)
466 Slur_score_state &state = *state_ptr;
467 state.slur_ = dynamic_cast<Spanner*> (me);
469 = Pointer_group_interface__extract_grobs (me, (Grob *) 0, "note-columns");
471 if (state.columns_.is_empty ())
477 state.staff_space_ = Staff_symbol_referencer::staff_space (me);
478 Real lt = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
479 state.thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
481 state.dir_ = get_grob_direction (me);
482 init_score_param (me, &state.parameters_);
484 SCM eltlist = me->get_property ("note-columns");
485 SCM extra_list = me->get_property ("encompass-objects");
486 Spanner *sp = dynamic_cast<Spanner*> (me);
488 for (int i = X_AXIS; i < NO_AXES; i++)
491 state.common_[a] = common_refpoint_of_list (eltlist, me, a);
492 state.common_[a] = common_refpoint_of_list (extra_list, state.common_[a], a);
496 state.common_[a] = state.common_[a]->common_refpoint (sp->get_bound (d), a);
498 while (flip (&d) != LEFT);
501 state.extremes_ = get_bound_info (state);
502 state.base_attachments_ = get_base_attachments (state);
504 Drul_array<Real> end_ys
505 = get_y_attachment_range (state);
507 state.scores_ = enumerate_attachments (state, end_ys);
508 for (int i = 0; i < state.columns_.size (); i++)
509 state.encompass_infos_.push (get_encompass_info (state, state.columns_[i]));
515 set_end_points (Grob *me)
517 Slur_score_state state;
518 fill_scoring_state (me, &state);
523 generate_curves (state);
525 score_slopes (state);
526 score_encompass (state);
527 score_extra_encompass (state);
531 for (int i = 0; i < state.scores_->size (); i++)
533 if ((*state.scores_)[i].score_ < opt)
535 opt = (*state.scores_)[i].score_;
540 #if DEBUG_SLUR_QUANTING
541 SCM inspect_quants = me->get_property ("inspect-quants");
542 if (to_boolean (me->get_paper ()
543 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
544 && scm_is_pair (inspect_quants))
546 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
548 for (int i = 0; i < state.scores_->size (); i ++)
550 Real d =fabs ((*state.scores_)[i].attachment_[LEFT][Y_AXIS] - ins[LEFT])
551 + fabs ((*state.scores_)[i].attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
559 programming_error ("Could not find quant.");
561 (*state.scores_)[opt_idx].score_card_ += to_string ("i%d", opt_idx);
564 me->set_property ("quant-score",
565 scm_makfrom0str ((*state.scores_)[opt_idx].score_card_.to_str0 ()));
568 Bezier b = (*state.scores_)[opt_idx].curve_;
569 SCM controls = SCM_EOL;
570 for (int i = 4; i--;)
572 Offset o = b.control_[i]
573 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
574 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
575 controls = scm_cons (ly_offset2scm (o), controls);
577 me->set_property ("control-points", controls);
581 TODO: should analyse encompasses to determine sensible region, and
582 should limit slopes available.
586 get_y_attachment_range (Slur_score_state const &state)
588 Drul_array<Real> end_ys;
592 if (state.extremes_[d].note_column_)
594 end_ys[d] = state.dir_
595 * ((state.dir_ * (state.base_attachments_[d][Y_AXIS] + state.parameters_.region_size_* state.dir_))
596 >? (state.dir_ * (state.dir_ + state.extremes_[d].note_column_->extent (state.common_[Y_AXIS],
597 Y_AXIS)[state.dir_]))
598 >? (state.dir_ * state.base_attachments_[-d][Y_AXIS]));
601 end_ys[d] = state.base_attachments_[d][Y_AXIS] + state.parameters_.region_size_ * state.dir_;
603 while (flip (&d) != LEFT);
609 spanner_less (Spanner *s1, Spanner* s2)
615 b1[d] = s1->get_bound (d)->get_column ()->rank_;
616 b2[d] = s2->get_bound (d)->get_column ()->rank_;
617 } while (flip (&d) != LEFT);
619 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
620 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
625 get_base_attachments (Slur_score_state const &state)
627 Drul_array<Offset> base_attachment;
631 Grob *stem = state.extremes_[d].stem_;
632 Grob *head = state.extremes_[d].slur_head_;
635 if (!state.extremes_[d].note_column_)
639 y = state.extremes_[d].neighbor_y_;
640 x = state.extremes_[d].bound_->extent (state.common_[X_AXIS], X_AXIS)[d];
644 x = state.slur_->get_broken_left_end_align ();
645 if (state.extremes_[RIGHT].bound_ == state.columns_[0])
647 y = base_attachment[RIGHT][Y_AXIS];
651 y = state.columns_[0]->extent (state.common_[Y_AXIS], Y_AXIS)[state.dir_];
658 (state.extremes_[d].stem_ && state.extremes_[-d].stem_
659 && Stem::get_beam (state.extremes_[d].stem_) == Stem::get_beam (state.extremes_[-d].stem_));
662 fixme: X coord should also be set in this case.
665 && state.extremes_[d].stem_dir_ == state.dir_
666 && Stem::get_beaming (stem, -d)
667 && (!spanner_less (state.slur_, Stem::get_beam (stem))
669 y = state.extremes_[d].stem_extent_[Y_AXIS][state.dir_];
671 y = head->extent (state.common_[Y_AXIS], Y_AXIS)[state.dir_];
672 y += state.dir_ * 0.5 * state.staff_space_;
675 = (y - state.extremes_[d].staff_->relative_coordinate (state.common_[Y_AXIS],
677 * 2.0 / state.staff_space_;
679 /* start off staffline. */
680 if (fabs (pos - my_round (pos)) < 0.2
681 && Staff_symbol_referencer::on_staffline (head, (int) rint (pos))
682 && Staff_symbol_referencer::line_count (head) - 1 >= rint (pos)
684 // TODO: calc from slur thick & line thick, parameter.
685 y += 1.5 * state.staff_space_ * state.dir_ / 10;
687 Grob * fh = Note_column::first_head (state.extremes_[d].note_column_);
689 (fh ? fh->extent (state.common_[X_AXIS], X_AXIS)
690 : state.extremes_[d].bound_->extent (state.common_[X_AXIS], X_AXIS))
691 .linear_combination (CENTER);
693 base_attachment[d] = Offset (x, y);
695 } while (flip (&d) != RIGHT);
697 return base_attachment;
701 generate_curves (Slur_score_state const &state)
703 Real r_0 = robust_scm2double (state.slur_->get_property ("ratio"), 0.33);
704 Real h_inf = state.staff_space_ *scm_to_double (state.slur_->get_property ("height-limit"));
705 for (int i = 0; i < state.scores_->size (); i++)
707 Bezier bez = get_bezier (state,
708 (*state.scores_)[i].attachment_, r_0, h_inf);
710 bez = avoid_staff_line (state, bez);
711 (*state.scores_)[i].attachment_[LEFT] = bez.control_[0];
712 (*state.scores_)[i].attachment_[RIGHT] = bez.control_[3];
713 (*state.scores_)[i].curve_ = bez;
718 avoid_staff_line (Slur_score_state const &state,
722 Array<Real> ts = bez.solve_derivative (horiz);
724 /* TODO: handle case of broken slur. */
726 && (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
727 && state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
729 Real y = bez.curve_point (ts[0])[Y_AXIS];
731 Grob *staff = state.extremes_[LEFT].staff_;
733 Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
734 / state.staff_space_;
736 Real distance = fabs (my_round (p) - p); // in halfspaces
737 if (distance < 4 * state.thickness_
738 && (int) fabs (my_round (p))
739 <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
740 && (int (fabs (my_round (p))) % 2
741 != Staff_symbol_referencer::line_count (staff) % 2))
743 Direction resolution_dir =
744 (distance ? state.dir_ : Direction (sign (p - my_round (p))));
747 Real newp = my_round (p) + resolution_dir
748 * 5 * state.thickness_;
750 Real dy = (newp - p) * state.staff_space_ / 2.0;
752 bez.control_[1][Y_AXIS] += dy;
753 bez.control_[2][Y_AXIS] += dy;
760 enumerate_attachments (Slur_score_state const &state, Drul_array<Real> end_ys)
763 Array<Slur_score> scores;
766 Drul_array<Offset> os;
767 os[LEFT] = state.base_attachments_[LEFT];
768 Real minimum_length = state.staff_space_
769 * robust_scm2double (state.slur_->get_property ("minimum-length"), 2.0);
771 for (int i = 0; state.dir_ * os[LEFT][Y_AXIS] <= state.dir_ * end_ys[LEFT]; i++)
773 os[RIGHT] = state.base_attachments_[RIGHT];
774 for (int j = 0; state.dir_ * os[RIGHT][Y_AXIS] <= state.dir_ * end_ys[RIGHT]; j++)
778 Drul_array<bool> attach_to_stem (false, false);
781 os[d][X_AXIS] = state.base_attachments_[d][X_AXIS];
782 if (state.extremes_[d].stem_
783 && !Stem::is_invisible (state.extremes_[d].stem_)
784 && state.extremes_[d].stem_dir_ == state.dir_)
786 Interval stem_y = state.extremes_[d].stem_extent_[Y_AXIS];
787 stem_y.widen (0.25 * state.staff_space_);
789 && stem_y.contains (os[d][Y_AXIS]))
791 os[d][X_AXIS] = state.extremes_[d].slur_head_extent_[-d]
793 attach_to_stem[d] = true;
795 else if (state.dir_ *state.extremes_[d].stem_extent_[Y_AXIS][state.dir_]
796 < state.dir_ * os[d][Y_AXIS]
797 && !state.extremes_[d].stem_extent_[X_AXIS].is_empty ()
800 os[d][X_AXIS] = state.extremes_[d].stem_extent_[X_AXIS].center ();
803 while (flip (&d) != LEFT);
806 dz = os[RIGHT] - os[LEFT];
807 if (dz[X_AXIS] < minimum_length
808 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > state.parameters_.max_slope_
813 if (state.extremes_[d].slur_head_)
815 os[d][X_AXIS] = state.extremes_[d].slur_head_extent_.center ();
816 attach_to_stem[d] = false;
819 while (flip (&d) != LEFT);
822 dz = os[RIGHT] - os[LEFT];
825 if (state.extremes_[d].slur_head_
826 && !attach_to_stem[d])
828 /* Horizontally move tilted slurs a little. Move
829 more for bigger tilts.
833 -= state.dir_ * state.extremes_[d].slur_head_extent_.length ()
834 * sin (dz.arg ()) / 3;
837 while (flip (&d) != LEFT);
842 os[RIGHT][Y_AXIS] += state.dir_ * state.staff_space_ / 2;
845 os[LEFT][Y_AXIS] += state.dir_ * state.staff_space_ / 2;
848 assert (scores.size () > 0);
849 return new Array<Slur_score> (scores);
853 linear_interpolate (Real x, Real x1, Real x2, Real y1, Real y2)
855 return (x2 - x) / (x2 - x1) * y1 +
856 (x - x1) / (x2 - x1) * y2 ;
861 score_encompass (Slur_score_state const &state)
863 Array<Encompass_info> infos;
866 for (int i = 0; i < state.scores_->size (); i++)
868 Slur_score &configuration = state.scores_->elem_ref (i);
869 Bezier const &bez (configuration.curve_);
873 Distances for heads that are between slur and line between
876 Array<Real> convex_head_distances;
877 Array<Real> edge_distances;
878 for (int j = 0; j < infos.size (); j++)
880 Real x = infos[j].x_;
883 bool r_edge = j==infos.size ()-1;
884 bool edge = l_edge || r_edge;
889 edge_distances.push (fabs (configuration.attachment_[l_edge ? LEFT : RIGHT][Y_AXIS]
890 - infos[j].get_point (state.dir_)));
894 if (! (x < configuration.attachment_[RIGHT][X_AXIS]
895 && x > configuration.attachment_[LEFT][X_AXIS]))
898 Real y = bez.get_other_coordinate (X_AXIS, x);
901 Real head_dy = (y - infos[j].head_);
902 if (state.dir_ * head_dy < 0)
904 demerit += state.parameters_.head_encompass_penalty_;
905 convex_head_distances.push (0.0);
910 ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
911 : state.parameters_.head_encompass_penalty_;
912 hd = (hd >? 0)<? state.parameters_.head_encompass_penalty_;
917 Real line_y = linear_interpolate (x,
918 configuration.attachment_[RIGHT][X_AXIS],
919 configuration.attachment_[LEFT][X_AXIS],
920 configuration.attachment_[RIGHT][Y_AXIS],
921 configuration.attachment_[LEFT][Y_AXIS]);
923 if ( 1 ) // state.dir_ * infos[j].get_point (state.dir_) > state.dir_ *line_y )
927 state.dir_ * (state.dir_ * infos[j].get_point (state.dir_)
928 >? state.dir_ *line_y
930 Real d = fabs (closest - y);
932 convex_head_distances.push (d);
938 if (state.dir_ * (y - infos[j].stem_) < 0)
940 Real stem_dem =state.parameters_.stem_encompass_penalty_ ;
941 if ((l_edge && state.dir_ == UP)
942 || (r_edge && state.dir_ == DOWN))
950 ext.add_point (infos[j].stem_);
951 ext.add_point (infos[j].head_);
954 demerit += -state.parameters_.closeness_factor_
956 * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_))
962 Real variance_penalty = 0.0;
964 if (convex_head_distances.size ())
966 Real avg_distance = 0.0;
967 Real min_dist = infinity_f;
968 for (int j = 0; j < convex_head_distances.size (); j++)
970 min_dist = min_dist <? convex_head_distances[j];
971 avg_distance += convex_head_distances[j];
975 For slurs over 3 or 4 heads, the average distance is not a
978 int n = convex_head_distances.size ();
979 if (convex_head_distances.size () <= 2)
981 // Real min_edge_dist = 1e6;
982 for (int j = 0; j < edge_distances.size (); j++)
984 avg_distance += edge_distances[j];
991 TODO: maybe it's better to use (avgdist - mindist)*factor
995 variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
997 variance_penalty = ((avg_distance / (min_dist +state.parameters_.free_head_distance_)) - 1.0)
1000 variance_penalty *= state.parameters_.head_slur_distance_factor_;
1002 #if DEBUG_SLUR_QUANTING
1003 (*state.scores_)[i].score_card_ += to_string ("C%.2f", demerit);
1004 (*state.scores_)[i].score_card_ += to_string ("D%.2f", variance_penalty);
1007 (*state.scores_)[i].score_ += demerit + variance_penalty;
1011 score_extra_encompass (Slur_score_state const &state)
1013 Link_array<Grob> encompasses
1014 = Pointer_group_interface__extract_grobs (state.slur_, (Grob *)0,
1015 "encompass-objects");
1016 Array<Extra_collision_info> collision_infos;
1017 for (int i = encompasses.size (); i--; )
1019 if (Slur::has_interface (encompasses[i]))
1021 Spanner * small_slur = dynamic_cast<Spanner*> (encompasses[i]);
1022 Bezier b = Slur::get_curve (small_slur);
1024 Offset relative (small_slur->relative_coordinate (state.common_[X_AXIS], X_AXIS),
1025 small_slur->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
1027 for (int k = 0; k < 3; k++)
1029 Direction hdir = Direction (k /2 - 1);
1032 Only take bound into account if small slur starts
1033 together with big slur.
1035 if (hdir && small_slur->get_bound (hdir) != state.slur_->get_bound (hdir))
1039 Offset z = b.curve_point ( k / 2.0);
1044 yext[state.dir_] = z[Y_AXIS] + state.dir_ * state.thickness_ * 1.0;
1046 Interval xext (-1, 1);
1047 xext = xext * (state.thickness_*2) + z[X_AXIS];
1048 Extra_collision_info info (small_slur,
1052 state.parameters_.extra_object_collision_);
1053 collision_infos.push (info);
1058 Grob *g = encompasses [i];
1059 Interval xe = g->extent (state.common_[X_AXIS], X_AXIS);
1060 Interval ye = g->extent (state.common_[Y_AXIS], Y_AXIS);
1063 Real penalty = state.parameters_.extra_object_collision_;
1064 if (Accidental_interface::has_interface (g))
1066 penalty = state.parameters_.accidental_collision_;
1067 /* Begin copy accidental.cc */
1068 bool parens = false;
1069 if (to_boolean (g->get_property ("cautionary")))
1071 SCM cstyle = g->get_property ("cautionary-style");
1072 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
1075 SCM accs = g->get_property ("accidentals");
1076 SCM scm_style = g->get_property ("style");
1077 if (!scm_is_symbol (scm_style)
1079 && scm_ilength (accs) == 1)
1081 /* End copy accidental.cc */
1082 switch (scm_to_int (ly_car (accs)))
1089 xp = 0.5 * state.dir_;
1098 ye.widen (state.thickness_ * 0.5);
1099 xe.widen (state.thickness_ * 1.0);
1100 Extra_collision_info info (g, xp, xe, ye, penalty);
1101 collision_infos.push (info);
1104 for (int i = 0; i < state.scores_->size (); i++)
1107 for (int j = 0; j < collision_infos.size (); j++)
1109 Drul_array<Offset> attachment = state.scores_->elem (i).attachment_;
1110 Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
1113 to prevent numerical inaccuracies in
1114 Bezier::get_other_coordinate ().
1123 We need to check for the bound explicitly, since the
1124 slur-ending can be almost vertical, making the Y
1125 coordinate a bad approximation of the object-slur
1128 Item * as_item = dynamic_cast<Item*> (collision_infos[j].grob_);
1130 && as_item->get_column ()
1131 == state.extremes_[d] .bound_->get_column ())
1132 || collision_infos[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
1134 y = attachment[d][Y_AXIS];
1138 while (flip (&d) != LEFT);
1142 Real x = collision_infos[j].extents_[X_AXIS]
1143 .linear_combination (collision_infos[j].idx_);
1145 if (!slur_wid.contains (x))
1148 y = state.scores_->elem (i).curve_.get_other_coordinate (X_AXIS, x);
1151 Real dist = collision_infos[j].extents_[Y_AXIS].distance (y);
1153 fabs (0 >? (state.parameters_.extra_encompass_free_distance_ - dist)) /
1154 state.parameters_.extra_encompass_free_distance_
1155 * collision_infos[j].penalty_;
1157 #if DEBUG_SLUR_QUANTING
1158 (*state.scores_)[i].score_card_ += to_string ("X%.2f", demerit);
1160 (*state.scores_)[i].score_ += demerit;
1165 score_edges (Slur_score_state const &state)
1167 for (int i = 0; i < state.scores_->size (); i++)
1170 Slur_score &config = state.scores_->elem_ref (i);
1171 Offset dz = config.attachment_[RIGHT] - config.attachment_[LEFT];
1172 Real slope = dz[Y_AXIS] / dz[X_AXIS];
1175 Real y = config.attachment_[d][Y_AXIS];
1176 Real dy = fabs (y - state.base_attachments_[d][Y_AXIS]);
1178 Real factor = state.parameters_.edge_attraction_factor_;
1179 Real demerit = factor * dy;
1180 if (state.extremes_[d].stem_
1181 && state.extremes_[d].stem_dir_ == state.dir_
1182 && !Stem::get_beaming (state.extremes_[d].stem_, -d)
1186 demerit *= exp (state.dir_ * d * slope
1187 * state.parameters_.edge_slope_exponent_ );
1189 (*state.scores_)[i].score_ += demerit;
1190 #if DEBUG_SLUR_QUANTING
1191 (*state.scores_)[i].score_card_ += to_string ("E%.2f", demerit);
1194 while (flip (&d) != LEFT);
1199 score_slopes (Slur_score_state const &state)
1202 Drul_array<Real> ys;
1206 if (state.extremes_[d].slur_head_)
1207 ys[d] = state.extremes_[d].slur_head_->relative_coordinate (state.common_[Y_AXIS],
1210 ys[d] = state.extremes_[d].neighbor_y_;
1212 while (flip (&d) != LEFT);
1215 = (state.extremes_[LEFT].stem_ && Stem::get_beam (state.extremes_[LEFT].stem_))
1216 || (state.extremes_[RIGHT].stem_ && Stem::get_beam (state.extremes_[RIGHT].stem_));
1218 Real dy = ys[RIGHT] - ys[LEFT];
1219 for (int i = 0; i < state.scores_->size (); i++)
1221 Offset slur_dz = (*state.scores_)[i].attachment_[RIGHT]
1222 - (*state.scores_)[i].attachment_[LEFT];
1223 Real slur_dy = slur_dz[Y_AXIS];
1226 demerit += ((fabs (slur_dy / slur_dz[X_AXIS])
1227 - state.parameters_.max_slope_) >? 0)
1228 * state.parameters_.max_slope_factor_;
1230 /* 0.2: account for staffline offset. */
1231 Real max_dy = (fabs (dy) + 0.2);
1235 demerit += state.parameters_.steeper_slope_factor_
1236 * ((fabs (slur_dy) -max_dy) >? 0);
1238 demerit += ((fabs (slur_dy/slur_dz[X_AXIS])
1239 - state.parameters_.max_slope_) >? 0)
1240 * state.parameters_.max_slope_factor_;
1243 && sign (slur_dy) != 0)
1244 demerit += state.parameters_.non_horizontal_penalty_;
1248 && sign (slur_dy) != sign (dy))
1249 demerit += has_beams
1250 ? state.parameters_.same_slope_penalty_ / 10
1251 : state.parameters_.same_slope_penalty_;
1253 #if DEBUG_SLUR_QUANTING
1254 (*state.scores_)[i].score_card_ += to_string ("S%.2f", d);
1256 (*state.scores_)[i].score_ += demerit;
1265 fit_factor (Offset dz_unit, Offset dz_perp,
1266 Bezier curve, Direction d, Array<Offset> const &avoid)
1268 Real fit_factor = 0.0;
1269 Offset x0 = curve.control_[0];
1270 curve.translate (-x0);
1271 curve.rotate (-dz_unit.arg ());
1274 Interval curve_xext;
1275 curve_xext.add_point (curve.control_[0][X_AXIS]);
1276 curve_xext.add_point (curve.control_[3][X_AXIS]);
1278 for (int i = 0; i < avoid.size (); i++)
1280 Offset z = (avoid[i] - x0) ;
1281 Offset p (dot_product (z, dz_unit),
1282 d* dot_product (z, dz_perp));
1283 if (!curve_xext.contains (p[X_AXIS]))
1286 Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
1289 fit_factor = fit_factor >? (p[Y_AXIS] / y);
1297 get_bezier (Slur_score_state const &state,
1298 Drul_array<Offset> attachments,
1299 Real r_0, Real h_inf
1302 Link_array<Grob> encompasses = state.columns_;
1304 Array<Offset> avoid;
1305 for (int i = 0; i < encompasses.size (); i++)
1307 if (state.extremes_[LEFT].note_column_ == encompasses[i]
1308 || state.extremes_[RIGHT].note_column_ == encompasses[i])
1311 Encompass_info inf (get_encompass_info (state, encompasses[i]));
1313 Real y = state.dir_ * ((state.dir_ * inf.head_) >? (state.dir_ *inf.stem_));
1315 avoid.push (Offset (inf.x_, y + state.dir_ * state.parameters_.free_head_distance_));
1318 Link_array<Grob> extra_encompasses
1319 = Pointer_group_interface__extract_grobs (state.slur_, (Grob *)0, "encompass-objects");
1320 for (int i = 0; i < extra_encompasses.size (); i++)
1321 if (Slur::has_interface (extra_encompasses[i]))
1323 Grob * small_slur = extra_encompasses[i];
1324 Bezier b = Slur::get_curve (small_slur);
1326 Offset z = b.curve_point (0.5);
1327 z += Offset (small_slur->relative_coordinate (state.common_[X_AXIS], X_AXIS),
1328 small_slur->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
1330 z[Y_AXIS] += state.dir_ * state.parameters_.free_slur_distance_;
1334 Offset dz = attachments[RIGHT]- attachments[LEFT];;
1335 Offset dz_unit = dz;
1336 dz_unit *= 1 / dz.length ();
1337 Offset dz_perp = dz_unit * Offset (0, 1);
1339 Real indent, height;
1340 get_slur_indent_height (&indent, &height, dz.length (), h_inf, r_0);
1342 Real excentricity = robust_scm2double (state.slur_->get_property ("excentricity"), 0);
1345 Real x1 = (excentricity + indent);
1346 Real x2 = (excentricity - indent);
1347 curve.control_[0] = attachments[LEFT];
1348 curve.control_[1] = attachments[LEFT] + dz_perp * height * state.dir_ + dz_unit * x1;
1349 curve.control_[2] = attachments[RIGHT] + dz_perp * height * state.dir_
1351 curve.control_[3] = attachments[RIGHT];
1353 Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
1354 Real len = dz.length ();
1358 len^2 > 4h^2 + 3 (i 1/3len)^2 - 1/3 len^2
1362 |bez' (0)| < | bez' (.5)|
1364 when (control2 - control1) has the same direction as
1365 (control3 - control0). */
1367 Real a1 = sqr (len) / 3.0;
1368 Real a2 = 0.75 * sqr (indent + len / 3.0);
1371 max_h = sqrt (a1 - a2);
1374 programming_error ("FIXME: max_h is broken; setting to length / 3");
1377 height = height >? ((height * ff) <? max_h);
1379 curve.control_[0] = attachments[LEFT];
1380 curve.control_[1] = attachments[LEFT] + dz_perp * height * state.dir_ + dz_unit * x1;
1381 curve.control_[2] = attachments[RIGHT] + dz_perp * height * state.dir_ + dz_unit * x2;
1382 curve.control_[3] = attachments[RIGHT];