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@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
13 #include "slur-scoring.hh"
14 #include "libc-extension.hh"
15 #include "slur-configuration.hh"
17 #include "directional-element-interface.hh"
18 #include "pointer-group-interface.hh"
20 #include "note-column.hh"
21 #include "output-def.hh"
24 #include "staff-symbol-referencer.hh"
25 #include "staff-symbol.hh"
28 #include "paper-column.hh"
29 #include "accidental-interface.hh"
34 - curve around flag for y coordinate
36 - short-cut: try a smaller region first.
38 - handle non-visible stems better.
40 - try to prune number of scoring criteria
42 - take encompass-objects more into account when determining
45 - calculate encompass scoring directly after determining slur shape.
49 struct Slur_score_state;
51 Slur_score_state::Slur_score_state ()
55 edge_has_beams_ = false;
56 has_same_beam_ = false;
64 Slur_score_state::~Slur_score_state ()
66 junk_pointers (configurations_);
70 get_detail (SCM alist, SCM sym)
72 SCM entry = scm_assq (sym, alist);
73 return robust_scm2double (scm_is_pair (entry)
80 Slur_score_parameters::fill (Grob *me)
82 SCM details = me->get_property ("slur-details");
85 = (int) get_detail (details, ly_symbol2scm ("region-size"));
86 head_encompass_penalty_
87 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
88 stem_encompass_penalty_
89 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
91 = get_detail (details, ly_symbol2scm ("closeness-factor"));
92 edge_attraction_factor_
93 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
95 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
97 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
98 non_horizontal_penalty_
99 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
101 = get_detail (details, ly_symbol2scm ("max-slope"));
103 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
105 = get_detail (details, ly_symbol2scm ("free-head-distance"));
106 absolute_closeness_measure_
107 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
108 extra_object_collision_
109 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
110 accidental_collision_
111 = get_detail (details, ly_symbol2scm ("accidental-collision"));
112 extra_encompass_free_distance_
113 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
114 head_slur_distance_factor_
115 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
116 head_slur_distance_max_ratio_
117 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
119 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
121 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
125 broken_trend_y (Slur_score_state const &state, Direction hdir)
127 /* A broken slur should maintain the same vertical trend
128 the unbroken slur would have had. */
130 if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original_))
132 int k = broken_spanner_index (state.slur_);
134 if (j < 0 || j >= mother->broken_intos_.size ())
137 Grob *neighbor = mother->broken_intos_[j];
138 Spanner *common_mother
139 = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original_);
141 = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
142 int common_j = common_k + hdir;
144 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
147 Grob *common_next_system = common_mother->broken_intos_[common_j];
149 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
151 return scm_to_double (scm_cdr (last_point))
152 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
158 copy slur dir forwards across line break.
161 Slur_score_state::set_next_direction ()
163 if (extremes_[RIGHT].note_column_)
166 if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original_))
168 int k = broken_spanner_index (slur_);
170 if (j < 0 || j >= mother->broken_intos_.size ())
173 Grob *neighbor = mother->broken_intos_[j];
174 set_grob_direction (neighbor, dir_);
179 Slur_score_state::get_encompass_info (Grob *col) const
181 Grob *stem = unsmob_grob (col->get_object ("stem"));
186 programming_error ("no stem for note column");
187 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
188 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
192 Direction stem_dir = get_grob_direction (stem);
194 if (Grob *head = Note_column::first_head (col))
195 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
197 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
199 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
202 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
206 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
208 if ((stem_dir == dir_)
209 && !stem->extent (stem, Y_AXIS).is_empty ())
211 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
212 if (Grob *b = Stem::get_beam (stem))
213 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
215 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
216 ei.x_ = x.is_empty ()
217 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
226 Drul_array<Bound_info>
227 Slur_score_state::get_bound_info () const
229 Drul_array<Bound_info> extremes;
232 Direction dir = dir_;
236 extremes[d].bound_ = slur_->get_bound (d);
237 if (Note_column::has_interface (extremes[d].bound_))
239 extremes[d].note_column_ = extremes[d].bound_;
240 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
241 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
243 for (int a = X_AXIS; a < NO_AXES; a++)
246 Interval s = extremes[d].stem_->extent (common_[ax], ax);
250 do not issue warning. This happens for rests and
254 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
256 extremes[d].stem_extent_[ax] = s;
259 extremes[d].slur_head_
260 = Stem::extremal_heads (extremes[d].stem_)[dir];
261 if (!extremes[d].slur_head_
262 && Note_column::has_rests (extremes[d].bound_))
263 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
265 if (extremes[d].slur_head_)
266 extremes[d].slur_head_extent_
267 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
269 extremes[d].staff_ = Staff_symbol_referencer
270 ::get_staff_symbol (extremes[d].stem_);
271 extremes[d].staff_space_ = Staff_symbol_referencer
272 ::staff_space (extremes[d].stem_);
275 while (flip (&d) != LEFT);
281 Slur_score_state::fill (Grob *me)
283 slur_ = dynamic_cast<Spanner *> (me);
285 = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
287 if (columns_.is_empty ())
293 staff_space_ = Staff_symbol_referencer::staff_space (me);
294 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
295 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
297 dir_ = get_grob_direction (me);
298 parameters_.fill (me);
300 extract_grob_set (me, "note-columns", columns);
301 extract_grob_set (me, "encompass-objects", extra_objects);
303 Spanner *sp = dynamic_cast<Spanner *> (me);
305 for (int i = X_AXIS; i < NO_AXES; i++)
308 common_[a] = common_refpoint_of_array (columns, me, a);
309 common_[a] = common_refpoint_of_array (extra_objects, common_[a], a);
315 If bound is not in note-columns, we don't want to know about
319 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
321 while (flip (&d) != LEFT);
324 extremes_ = get_bound_info ();
325 is_broken_ = (!extremes_[LEFT].note_column_
326 || !extremes_[RIGHT].note_column_);
329 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
330 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
332 base_attachments_ = get_base_attachments ();
334 Drul_array<Real> end_ys
335 = get_y_attachment_range ();
337 configurations_ = enumerate_attachments (end_ys);
338 for (int i = 0; i < columns_.size (); i++)
339 encompass_infos_.push (get_encompass_info (columns_[i]));
341 extra_encompass_infos_ = get_extra_encompass_infos ();
350 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
352 while (flip (&d) != LEFT);
355 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
356 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
358 set_next_direction ();
365 set_slur_control_points (Grob *me)
367 Slur_score_state state;
373 state.generate_curves ();
375 SCM end_ys = me->get_property ("positions");
378 if (is_number_pair (end_ys))
379 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
381 best = state.get_best_curve ();
383 SCM controls = SCM_EOL;
384 for (int i = 4; i--;)
386 Offset o = best.control_[i]
387 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
388 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
389 controls = scm_cons (ly_offset2scm (o), controls);
391 me->set_property ("control-points", controls);
395 Slur_score_state::get_best_curve ()
400 #if DEBUG_SLUR_SCORING
401 SCM inspect_quants = slur_->get_property ("inspect-quants");
402 if (to_boolean (slur_->get_layout ()
403 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
404 && scm_is_pair (inspect_quants))
406 opt_idx = get_closest_index (inspect_quants);
407 configurations_[opt_idx]->score (*this);
408 opt = configurations_[opt_idx]->score_;
413 for (int i = 0; i < configurations_.size (); i++)
414 configurations_[i]->score (*this);
415 for (int i = 0; i < configurations_.size (); i++)
417 if (configurations_[i]->score_ < opt)
419 opt = configurations_[i]->score_;
425 #if DEBUG_SLUR_SCORING
426 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
427 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
430 slur_->set_property ("quant-score",
431 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
435 return configurations_[opt_idx]->curve_;
439 Slur_score_state::get_closest_index (SCM inspect_quants) const
441 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
445 for (int i = 0; i < configurations_.size (); i++)
447 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
448 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
456 programming_error ("can't not find quant");
461 TODO: should analyse encompasses to determine sensible region, and
462 should limit slopes available.
466 Slur_score_state::get_y_attachment_range () const
468 Drul_array<Real> end_ys;
472 if (extremes_[d].note_column_)
475 * max (max (dir_ * (base_attachments_[d][Y_AXIS]
476 + parameters_.region_size_ * dir_),
477 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
478 dir_ * base_attachments_[-d][Y_AXIS]);
481 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
483 while (flip (&d) != LEFT);
489 spanner_less (Spanner *s1, Spanner *s2)
495 b1[d] = s1->get_bound (d)->get_column ()->get_rank ();
496 b2[d] = s2->get_bound (d)->get_column ()->get_rank ();
498 while (flip (&d) != LEFT);
500 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
501 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
505 Slur_score_state::get_base_attachments () const
507 Drul_array<Offset> base_attachment;
511 Grob *stem = extremes_[d].stem_;
512 Grob *head = extremes_[d].slur_head_;
516 if (extremes_[d].note_column_)
520 fixme: X coord should also be set in this case.
523 && !Stem::is_invisible (stem)
524 && extremes_[d].stem_dir_ == dir_
525 && Stem::get_beaming (stem, -d)
526 && (!spanner_less (slur_, Stem::get_beam (stem))
528 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
530 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
531 y += dir_ * 0.5 * staff_space_;
533 y = move_away_from_staffline (y, head);
535 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
537 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
538 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
539 .linear_combination (CENTER);
541 base_attachment[d] = Offset (x, y);
543 while (flip (&d) != LEFT);
547 if (!extremes_[d].note_column_)
551 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
553 x = slur_->get_broken_left_end_align ();
554 Grob *col = (d == LEFT) ? columns_[0] : columns_.top ();
556 if (extremes_[-d].bound_ != col)
558 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
559 y += dir_ * 0.5 * staff_space_;
561 if (get_grob_direction (col) == dir_
562 && Note_column::get_stem (col)
563 && !Stem::is_invisible (Note_column::get_stem (col)))
564 y -= dir_ * 1.5 * staff_space_;
567 y = base_attachment[-d][Y_AXIS];
569 y = move_away_from_staffline (y, col);
571 base_attachment[d] = Offset (x, y);
574 while (flip (&d) != LEFT);
578 for (int a = X_AXIS; a < NO_AXES; a++)
580 Real &b = base_attachment[d][Axis (a)];
582 if (isinf (b) || isnan (b))
584 programming_error ("slur attachment is inf/nan");
589 while (flip (&d) != LEFT);
591 return base_attachment;
595 Slur_score_state::move_away_from_staffline (Real y,
596 Grob *on_staff) const
598 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
603 = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
605 * 2.0 / staff_space_;
607 if (fabs (pos - my_round (pos)) < 0.2
608 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
609 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
610 y += 1.5 * staff_space_ * dir_ / 10;
616 Slur_score_state::generate_avoid_offsets () const
619 Link_array<Grob> encompasses = columns_;
621 for (int i = 0; i < encompasses.size (); i++)
623 if (extremes_[LEFT].note_column_ == encompasses[i]
624 || extremes_[RIGHT].note_column_ == encompasses[i])
627 Encompass_info inf (get_encompass_info (encompasses[i]));
628 Real y = dir_ * (max (dir_ * inf.head_, dir_ * inf.stem_));
630 avoid.push (Offset (inf.x_, y + dir_ * parameters_.free_head_distance_));
633 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
634 for (int i = 0; i < extra_encompasses.size (); i++)
635 if (Slur::has_interface (extra_encompasses[i]))
637 Grob *small_slur = extra_encompasses[i];
638 Bezier b = Slur::get_curve (small_slur);
640 Offset z = b.curve_point (0.5);
641 z += Offset (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
642 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
644 z[Y_AXIS] += dir_ * parameters_.free_slur_distance_;
652 Slur_score_state::generate_curves () const
654 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
655 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
657 Array<Offset> avoid = generate_avoid_offsets ();
658 for (int i = 0; i < configurations_.size (); i++)
659 configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
662 Link_array<Slur_configuration>
663 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
665 Link_array<Slur_configuration> scores;
667 Drul_array<Offset> os;
668 os[LEFT] = base_attachments_[LEFT];
669 Real minimum_length = staff_space_
670 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
672 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
674 os[RIGHT] = base_attachments_[RIGHT];
675 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
677 Slur_configuration s;
679 Drul_array<bool> attach_to_stem (false, false);
682 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
683 if (extremes_[d].stem_
684 && !Stem::is_invisible (extremes_[d].stem_)
685 && extremes_[d].stem_dir_ == dir_)
687 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
688 stem_y.widen (0.25 * staff_space_);
689 if (stem_y.contains (os[d][Y_AXIS]))
691 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
693 attach_to_stem[d] = true;
695 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
696 < dir_ * os[d][Y_AXIS]
697 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
699 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
702 while (flip (&d) != LEFT);
705 dz = os[RIGHT] - os[LEFT];
706 if (dz[X_AXIS] < minimum_length
707 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
711 if (extremes_[d].slur_head_)
713 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
714 attach_to_stem[d] = false;
717 while (flip (&d) != LEFT);
720 dz = os[RIGHT] - os[LEFT];
723 if (extremes_[d].slur_head_
724 && !attach_to_stem[d])
726 /* Horizontally move tilted slurs a little. Move
727 more for bigger tilts.
731 -= dir_ * extremes_[d].slur_head_extent_.length ()
732 * sin (dz.arg ()) / 3;
735 while (flip (&d) != LEFT);
738 s.index_ = scores.size ();
740 scores.push (new Slur_configuration (s));
742 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
745 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
748 assert (scores.size () > 0);
752 Array<Extra_collision_info>
753 Slur_score_state::get_extra_encompass_infos () const
755 extract_grob_set (slur_, "encompass-objects", encompasses);
756 Array<Extra_collision_info> collision_infos;
757 for (int i = encompasses.size (); i--;)
759 if (Slur::has_interface (encompasses[i]))
761 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
762 Bezier b = Slur::get_curve (small_slur);
764 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
765 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
767 for (int k = 0; k < 3; k++)
769 Direction hdir = Direction (k / 2 - 1);
772 Only take bound into account if small slur starts
773 together with big slur.
775 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
778 Offset z = b.curve_point (k / 2.0);
783 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
785 Interval xext (-1, 1);
786 xext = xext * (thickness_ * 2) + z[X_AXIS];
787 Extra_collision_info info (small_slur,
791 parameters_.extra_object_collision_);
792 collision_infos.push (info);
797 Grob *g = encompasses [i];
798 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
799 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
802 Real penalty = parameters_.extra_object_collision_;
803 if (Accidental_interface::has_interface (g))
805 penalty = parameters_.accidental_collision_;
806 /* Begin copy accidental.cc */
808 if (to_boolean (g->get_property ("cautionary")))
810 SCM cstyle = g->get_property ("cautionary-style");
811 parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
814 SCM accs = g->get_property ("accidentals");
815 SCM scm_style = g->get_property ("style");
816 if (!scm_is_symbol (scm_style)
818 && scm_ilength (accs) == 1)
820 /* End copy accidental.cc */
821 switch (scm_to_int (scm_car (accs)))
837 ye.widen (thickness_ * 0.5);
838 xe.widen (thickness_ * 1.0);
839 Extra_collision_info info (g, xp, xe, ye, penalty);
840 collision_infos.push (info);
844 return collision_infos;