2 slur-scoring.cc -- Score based slur formatting
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
11 #include "slur-scoring.hh"
12 #include "libc-extension.hh"
13 #include "slur-configuration.hh"
15 #include "directional-element-interface.hh"
16 #include "pointer-group-interface.hh"
18 #include "note-column.hh"
19 #include "output-def.hh"
22 #include "staff-symbol-referencer.hh"
23 #include "staff-symbol.hh"
26 #include "paper-column.hh"
27 #include "accidental-interface.hh"
32 - curve around flag for y coordinate
34 - short-cut: try a smaller region first.
36 - handle non-visible stems better.
38 - try to prune number of scoring criteria
40 - take encompass-objects more into account when determining
43 - calculate encompass scoring directly after determining slur shape.
47 struct Slur_score_state;
49 Slur_score_state::Slur_score_state ()
53 edge_has_beams_ = false;
54 has_same_beam_ = false;
62 Slur_score_state::~Slur_score_state ()
64 junk_pointers (configurations_);
68 get_detail (SCM alist, SCM sym)
70 SCM entry = scm_assq (sym, alist);
71 return robust_scm2double (scm_is_pair (entry)
78 Slur_score_parameters::fill (Grob *me)
80 SCM details = me->get_property ("slur-details");
83 = (int) get_detail (details, ly_symbol2scm ("region-size"));
84 head_encompass_penalty_
85 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
86 stem_encompass_penalty_
87 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
89 = get_detail (details, ly_symbol2scm ("closeness-factor"));
90 edge_attraction_factor_
91 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
93 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
95 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
96 non_horizontal_penalty_
97 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
99 = get_detail (details, ly_symbol2scm ("max-slope"));
101 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
103 = get_detail (details, ly_symbol2scm ("free-head-distance"));
104 absolute_closeness_measure_
105 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
106 extra_object_collision_
107 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
108 accidental_collision_
109 = get_detail (details, ly_symbol2scm ("accidental-collision"));
110 extra_encompass_free_distance_
111 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
112 head_slur_distance_factor_
113 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
114 head_slur_distance_max_ratio_
115 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
117 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
119 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
123 broken_trend_y (Slur_score_state const &state, Direction hdir)
125 /* A broken slur should maintain the same vertical trend
126 the unbroken slur would have had. */
128 if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original ()))
130 int k = broken_spanner_index (state.slur_);
132 if (j < 0 || j >= mother->broken_intos_.size ())
135 Grob *neighbor = mother->broken_intos_[j];
136 Spanner *common_mother
137 = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original ());
139 = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
140 int common_j = common_k + hdir;
142 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
145 Grob *common_next_system = common_mother->broken_intos_[common_j];
147 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
149 return scm_to_double (scm_cdr (last_point))
150 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
156 copy slur dir forwards across line break.
159 Slur_score_state::set_next_direction ()
161 if (extremes_[RIGHT].note_column_)
164 if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original ()))
166 int k = broken_spanner_index (slur_);
168 if (j < 0 || j >= mother->broken_intos_.size ())
171 Grob *neighbor = mother->broken_intos_[j];
172 set_grob_direction (neighbor, dir_);
177 Slur_score_state::get_encompass_info (Grob *col) const
179 Grob *stem = unsmob_grob (col->get_object ("stem"));
184 programming_error ("no stem for note column");
185 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
186 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
190 Direction stem_dir = get_grob_direction (stem);
192 if (Grob *head = Note_column::first_head (col))
193 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
195 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
197 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
200 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
204 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
206 if ((stem_dir == dir_)
207 && !stem->extent (stem, Y_AXIS).is_empty ())
209 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
210 if (Grob *b = Stem::get_beam (stem))
211 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
213 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
214 ei.x_ = x.is_empty ()
215 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
224 Drul_array<Bound_info>
225 Slur_score_state::get_bound_info () const
227 Drul_array<Bound_info> extremes;
230 Direction dir = dir_;
234 extremes[d].bound_ = slur_->get_bound (d);
235 if (Note_column::has_interface (extremes[d].bound_))
237 extremes[d].note_column_ = extremes[d].bound_;
238 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
239 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
241 for (int a = X_AXIS; a < NO_AXES; a++)
244 Interval s = extremes[d].stem_->extent (common_[ax], ax);
248 do not issue warning. This happens for rests and
252 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
254 extremes[d].stem_extent_[ax] = s;
257 extremes[d].slur_head_
258 = Stem::extremal_heads (extremes[d].stem_)[dir];
259 if (!extremes[d].slur_head_
260 && Note_column::has_rests (extremes[d].bound_))
261 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
263 if (extremes[d].slur_head_)
264 extremes[d].slur_head_extent_
265 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
267 extremes[d].staff_ = Staff_symbol_referencer
268 ::get_staff_symbol (extremes[d].stem_);
269 extremes[d].staff_space_ = Staff_symbol_referencer
270 ::staff_space (extremes[d].stem_);
273 while (flip (&d) != LEFT);
279 Slur_score_state::fill (Grob *me)
281 slur_ = dynamic_cast<Spanner *> (me);
283 = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
285 if (columns_.is_empty ())
291 staff_space_ = Staff_symbol_referencer::staff_space (me);
292 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("linethickness"));
293 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
295 dir_ = get_grob_direction (me);
296 parameters_.fill (me);
298 extract_grob_set (me, "note-columns", columns);
299 extract_grob_set (me, "encompass-objects", extra_objects);
301 Spanner *sp = dynamic_cast<Spanner *> (me);
303 for (int i = X_AXIS; i < NO_AXES; i++)
306 common_[a] = common_refpoint_of_array (columns, me, a);
307 common_[a] = common_refpoint_of_array (extra_objects, common_[a], a);
313 If bound is not in note-columns, we don't want to know about
317 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
319 while (flip (&d) != LEFT);
322 extremes_ = get_bound_info ();
323 is_broken_ = (!extremes_[LEFT].note_column_
324 || !extremes_[RIGHT].note_column_);
327 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
328 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
330 base_attachments_ = get_base_attachments ();
332 Drul_array<Real> end_ys
333 = get_y_attachment_range ();
335 configurations_ = enumerate_attachments (end_ys);
336 for (int i = 0; i < columns_.size (); i++)
337 encompass_infos_.push (get_encompass_info (columns_[i]));
339 extra_encompass_infos_ = get_extra_encompass_infos ();
348 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
350 while (flip (&d) != LEFT);
353 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
354 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
356 set_next_direction ();
363 MAKE_SCHEME_CALLBACK(Slur, calc_control_points, 1)
365 Slur::calc_control_points (SCM smob)
367 Spanner *me = unsmob_spanner (smob);
369 Slur_score_state state;
375 state.generate_curves ();
377 SCM end_ys = me->get_property ("positions");
380 if (is_number_pair (end_ys))
381 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
383 best = state.get_best_curve ();
385 SCM controls = SCM_EOL;
386 for (int i = 4; i--;)
388 Offset o = best.control_[i]
389 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
390 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
391 controls = scm_cons (ly_offset2scm (o), controls);
398 Slur_score_state::get_best_curve ()
403 #if DEBUG_SLUR_SCORING
404 SCM inspect_quants = slur_->get_property ("inspect-quants");
405 if (to_boolean (slur_->layout ()
406 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
407 && scm_is_pair (inspect_quants))
409 opt_idx = get_closest_index (inspect_quants);
410 configurations_[opt_idx]->score (*this);
411 opt = configurations_[opt_idx]->score_;
416 for (int i = 0; i < configurations_.size (); i++)
417 configurations_[i]->score (*this);
418 for (int i = 0; i < configurations_.size (); i++)
420 if (configurations_[i]->score_ < opt)
422 opt = configurations_[i]->score_;
428 #if DEBUG_SLUR_SCORING
429 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
430 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
433 slur_->set_property ("quant-score",
434 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
438 return configurations_[opt_idx]->curve_;
442 Slur_score_state::get_closest_index (SCM inspect_quants) const
444 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
448 for (int i = 0; i < configurations_.size (); i++)
450 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
451 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
459 programming_error ("can't not find quant");
464 TODO: should analyse encompasses to determine sensible region, and
465 should limit slopes available.
469 Slur_score_state::get_y_attachment_range () const
471 Drul_array<Real> end_ys;
475 if (extremes_[d].note_column_)
478 * max (max (dir_ * (base_attachments_[d][Y_AXIS]
479 + parameters_.region_size_ * dir_),
480 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
481 dir_ * base_attachments_[-d][Y_AXIS]);
484 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
486 while (flip (&d) != LEFT);
492 spanner_less (Spanner *s1, Spanner *s2)
498 b1[d] = s1->get_bound (d)->get_column ()->get_rank ();
499 b2[d] = s2->get_bound (d)->get_column ()->get_rank ();
501 while (flip (&d) != LEFT);
503 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
504 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
508 Slur_score_state::get_base_attachments () const
510 Drul_array<Offset> base_attachment;
514 Grob *stem = extremes_[d].stem_;
515 Grob *head = extremes_[d].slur_head_;
519 if (extremes_[d].note_column_)
523 fixme: X coord should also be set in this case.
526 && !Stem::is_invisible (stem)
527 && extremes_[d].stem_dir_ == dir_
528 && Stem::get_beaming (stem, -d)
529 && (!spanner_less (slur_, Stem::get_beam (stem))
531 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
533 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
534 y += dir_ * 0.5 * staff_space_;
536 y = move_away_from_staffline (y, head);
538 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
540 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
541 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
542 .linear_combination (CENTER);
544 base_attachment[d] = Offset (x, y);
546 while (flip (&d) != LEFT);
550 if (!extremes_[d].note_column_)
554 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
556 x = slur_->get_broken_left_end_align ();
557 Grob *col = (d == LEFT) ? columns_[0] : columns_.top ();
559 if (extremes_[-d].bound_ != col)
561 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
562 y += dir_ * 0.5 * staff_space_;
564 if (get_grob_direction (col) == dir_
565 && Note_column::get_stem (col)
566 && !Stem::is_invisible (Note_column::get_stem (col)))
567 y -= dir_ * 1.5 * staff_space_;
570 y = base_attachment[-d][Y_AXIS];
572 y = move_away_from_staffline (y, col);
574 base_attachment[d] = Offset (x, y);
577 while (flip (&d) != LEFT);
581 for (int a = X_AXIS; a < NO_AXES; a++)
583 Real &b = base_attachment[d][Axis (a)];
585 if (isinf (b) || isnan (b))
587 programming_error ("slur attachment is inf/nan");
592 while (flip (&d) != LEFT);
594 return base_attachment;
598 Slur_score_state::move_away_from_staffline (Real y,
599 Grob *on_staff) const
601 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
606 = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
608 * 2.0 / staff_space_;
610 if (fabs (pos - my_round (pos)) < 0.2
611 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
612 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
613 y += 1.5 * staff_space_ * dir_ / 10;
619 Slur_score_state::generate_avoid_offsets () const
622 Link_array<Grob> encompasses = columns_;
624 for (int i = 0; i < encompasses.size (); i++)
626 if (extremes_[LEFT].note_column_ == encompasses[i]
627 || extremes_[RIGHT].note_column_ == encompasses[i])
630 Encompass_info inf (get_encompass_info (encompasses[i]));
631 Real y = dir_ * (max (dir_ * inf.head_, dir_ * inf.stem_));
633 avoid.push (Offset (inf.x_, y + dir_ * parameters_.free_head_distance_));
636 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
637 for (int i = 0; i < extra_encompasses.size (); i++)
638 if (Slur::has_interface (extra_encompasses[i]))
640 Grob *small_slur = extra_encompasses[i];
641 Bezier b = Slur::get_curve (small_slur);
643 Offset z = b.curve_point (0.5);
644 z += Offset (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
645 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
647 z[Y_AXIS] += dir_ * parameters_.free_slur_distance_;
655 Slur_score_state::generate_curves () const
657 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
658 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
660 Array<Offset> avoid = generate_avoid_offsets ();
661 for (int i = 0; i < configurations_.size (); i++)
662 configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
665 Link_array<Slur_configuration>
666 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
668 Link_array<Slur_configuration> scores;
670 Drul_array<Offset> os;
671 os[LEFT] = base_attachments_[LEFT];
672 Real minimum_length = staff_space_
673 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
675 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
677 os[RIGHT] = base_attachments_[RIGHT];
678 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
680 Slur_configuration s;
682 Drul_array<bool> attach_to_stem (false, false);
685 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
686 if (extremes_[d].stem_
687 && !Stem::is_invisible (extremes_[d].stem_)
688 && extremes_[d].stem_dir_ == dir_)
690 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
691 stem_y.widen (0.25 * staff_space_);
692 if (stem_y.contains (os[d][Y_AXIS]))
694 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
696 attach_to_stem[d] = true;
698 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
699 < dir_ * os[d][Y_AXIS]
700 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
702 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
705 while (flip (&d) != LEFT);
708 dz = os[RIGHT] - os[LEFT];
709 if (dz[X_AXIS] < minimum_length
710 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
714 if (extremes_[d].slur_head_
715 && !extremes_[d].slur_head_extent_.is_empty ())
717 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
718 attach_to_stem[d] = false;
721 while (flip (&d) != LEFT);
724 dz = os[RIGHT] - os[LEFT];
727 if (extremes_[d].slur_head_
728 && !attach_to_stem[d])
730 /* Horizontally move tilted slurs a little. Move
731 more for bigger tilts.
735 -= dir_ * extremes_[d].slur_head_extent_.length ()
736 * sin (dz.arg ()) / 3;
739 while (flip (&d) != LEFT);
742 s.index_ = scores.size ();
744 scores.push (new Slur_configuration (s));
746 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
749 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
752 assert (scores.size () > 0);
756 Array<Extra_collision_info>
757 Slur_score_state::get_extra_encompass_infos () const
759 extract_grob_set (slur_, "encompass-objects", encompasses);
760 Array<Extra_collision_info> collision_infos;
761 for (int i = encompasses.size (); i--;)
763 if (Slur::has_interface (encompasses[i]))
765 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
766 Bezier b = Slur::get_curve (small_slur);
768 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
769 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
771 for (int k = 0; k < 3; k++)
773 Direction hdir = Direction (k / 2 - 1);
776 Only take bound into account if small slur starts
777 together with big slur.
779 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
782 Offset z = b.curve_point (k / 2.0);
787 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
789 Interval xext (-1, 1);
790 xext = xext * (thickness_ * 2) + z[X_AXIS];
791 Extra_collision_info info (small_slur,
795 parameters_.extra_object_collision_);
796 collision_infos.push (info);
801 Grob *g = encompasses [i];
802 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
803 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
806 Real penalty = parameters_.extra_object_collision_;
807 if (Accidental_interface::has_interface (g))
809 penalty = parameters_.accidental_collision_;
810 /* Begin copy accidental.cc */
812 if (to_boolean (g->get_property ("cautionary")))
814 SCM cstyle = g->get_property ("cautionary-style");
815 parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
818 SCM accs = g->get_property ("accidentals");
819 SCM scm_style = g->get_property ("style");
820 if (!scm_is_symbol (scm_style)
822 && scm_ilength (accs) == 1)
824 /* End copy accidental.cc */
825 switch (scm_to_int (scm_car (accs)))
841 ye.widen (thickness_ * 0.5);
842 xe.widen (thickness_ * 1.0);
843 Extra_collision_info info (g, xp, xe, ye, penalty);
844 collision_infos.push (info);
848 return collision_infos;