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>
12 #include "slur-scoring.hh"
13 #include "libc-extension.hh"
14 #include "slur-configuration.hh"
16 #include "directional-element-interface.hh"
17 #include "group-interface.hh"
19 #include "note-column.hh"
20 #include "output-def.hh"
23 #include "staff-symbol-referencer.hh"
24 #include "staff-symbol.hh"
27 #include "paper-column.hh"
28 #include "accidental-interface.hh"
33 - curve around flag for y coordinate
35 - this file is a 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.
50 struct Slur_score_state;
52 Slur_score_state::Slur_score_state ()
56 edge_has_beams_ = false;
57 has_same_beam_ = false;
65 Slur_score_state::~Slur_score_state ()
67 junk_pointers (configurations_);
71 get_detail (SCM alist, SCM sym)
73 SCM entry = scm_assq (sym, alist);
74 return robust_scm2double (scm_is_pair (entry)
81 Slur_score_parameters::fill (Grob *me)
83 SCM details = me->get_property ("slur-details");
86 = (int) get_detail (details, ly_symbol2scm ("region-size"));
87 head_encompass_penalty_
88 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
89 stem_encompass_penalty_
90 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
92 = get_detail (details, ly_symbol2scm ("closeness-factor"));
93 edge_attraction_factor_
94 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
96 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
98 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
99 non_horizontal_penalty_
100 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
102 = get_detail (details, ly_symbol2scm ("max-slope"));
104 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
106 = get_detail (details, ly_symbol2scm ("free-head-distance"));
107 absolute_closeness_measure_
108 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
109 extra_object_collision_
110 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
111 accidental_collision_
112 = get_detail (details, ly_symbol2scm ("accidental-collision"));
113 extra_encompass_free_distance_
114 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
115 head_slur_distance_factor_
116 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
117 head_slur_distance_max_ratio_
118 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
120 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
122 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
126 broken_trend_y (Slur_score_state const &state, Direction hdir)
128 /* A broken slur should maintain the same vertical trend
129 the unbroken slur would have had. */
131 if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original_))
133 int k = broken_spanner_index (state.slur_);
135 if (j < 0 || j >= mother->broken_intos_.size ())
138 Grob *neighbor = mother->broken_intos_[j];
139 Spanner *common_mother
140 = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original_);
142 = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
143 int common_j = common_k + hdir;
145 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
148 Grob *common_next_system = common_mother->broken_intos_[common_j];
150 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
152 return scm_to_double (scm_cdr (last_point))
153 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
159 copy slur dir forwards across line break.
162 Slur_score_state::set_next_direction ()
164 if (extremes_[RIGHT].note_column_)
167 if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original_))
169 int k = broken_spanner_index (slur_);
171 if (j < 0 || j >= mother->broken_intos_.size ())
174 Grob *neighbor = mother->broken_intos_[j];
175 set_grob_direction (neighbor, dir_);
180 Slur_score_state::get_encompass_info (Grob *col) const
182 Grob *stem = unsmob_grob (col->get_property ("stem"));
187 programming_error ("no stem for note column");
188 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
189 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
193 Direction stem_dir = get_grob_direction (stem);
195 if (Grob *head = Note_column::first_head (col))
196 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
198 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
200 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
203 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
207 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
209 if ((stem_dir == dir_)
210 && !stem->extent (stem, Y_AXIS).is_empty ())
212 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
213 if (Grob *b = Stem::get_beam (stem))
214 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
216 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
217 ei.x_ = x.is_empty ()
218 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
227 Drul_array<Bound_info>
228 Slur_score_state::get_bound_info () const
230 Drul_array<Bound_info> extremes;
233 Direction dir = dir_;
237 extremes[d].bound_ = slur_->get_bound (d);
238 if (Note_column::has_interface (extremes[d].bound_))
240 extremes[d].note_column_ = extremes[d].bound_;
241 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
242 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
244 for (int a = X_AXIS; a < NO_AXES; a++)
247 Interval s = extremes[d].stem_->extent (common_[ax], ax);
250 programming_error ("Stem has no extent in Slur_score_state");
252 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
254 extremes[d].stem_extent_[ax] = s;
257 extremes[d].stem_extent_[Y_AXIS]
258 = extremes[d].stem_->extent (common_[Y_AXIS], Y_AXIS);
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_))
264 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
267 if (extremes[d].slur_head_)
268 extremes[d].slur_head_extent_
269 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
271 extremes[d].staff_ = Staff_symbol_referencer
272 ::get_staff_symbol (extremes[d].stem_);
273 extremes[d].staff_space_ = Staff_symbol_referencer
274 ::staff_space (extremes[d].stem_);
277 while (flip (&d) != LEFT);
283 Slur_score_state::fill (Grob *me)
285 slur_ = dynamic_cast<Spanner *> (me);
287 = extract_grob_array (me, ly_symbol2scm ("note-columns"));
289 if (columns_.is_empty ())
295 staff_space_ = Staff_symbol_referencer::staff_space (me);
296 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
297 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
299 dir_ = get_grob_direction (me);
300 parameters_.fill (me);
302 SCM eltlist = me->get_property ("note-columns");
303 SCM extra_list = me->get_property ("encompass-objects");
304 Spanner *sp = dynamic_cast<Spanner *> (me);
306 for (int i = X_AXIS; i < NO_AXES; i++)
309 common_[a] = common_refpoint_of_list (eltlist, me, a);
310 common_[a] = common_refpoint_of_list (extra_list, common_[a], a);
316 If bound is not in note-columns, we don't want to know about
320 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
322 while (flip (&d) != LEFT);
325 extremes_ = get_bound_info ();
326 is_broken_ = (!extremes_[LEFT].note_column_
327 || !extremes_[RIGHT].note_column_);
330 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
331 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
333 base_attachments_ = get_base_attachments ();
335 Drul_array<Real> end_ys
336 = get_y_attachment_range ();
338 configurations_ = enumerate_attachments (end_ys);
339 for (int i = 0; i < columns_.size (); i++)
340 encompass_infos_.push (get_encompass_info (columns_[i]));
342 extra_encompass_infos_ = get_extra_encompass_infos ();
351 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
353 while (flip (&d) != LEFT);
356 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
357 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
359 set_next_direction ();
366 set_slur_control_points (Grob *me)
368 Slur_score_state state;
374 state.generate_curves ();
376 SCM end_ys = me->get_property ("positions");
379 if (is_number_pair (end_ys))
381 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
385 best = state.get_best_curve ();
388 SCM controls = SCM_EOL;
389 for (int i = 4; i--;)
391 Offset o = best.control_[i]
392 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
393 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
394 controls = scm_cons (ly_offset2scm (o), controls);
396 me->set_property ("control-points", controls);
400 Slur_score_state::get_best_curve ()
402 for (int i = 0; i < configurations_.size (); i++)
404 configurations_[i]->score (*this);
409 for (int i = 0; i < configurations_.size (); i++)
411 if (configurations_[i]->score_ < opt)
413 opt = configurations_[i]->score_;
418 #if DEBUG_SLUR_SCORING
419 SCM inspect_quants = slur_->get_property ("inspect-quants");
420 if (to_boolean (slur_->get_layout ()
421 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
422 && scm_is_pair (inspect_quants))
423 opt_idx = get_closest_index (inspect_quants);
425 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
426 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
429 slur_->set_property ("quant-score",
430 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
434 return configurations_[opt_idx]->curve_;
438 Slur_score_state::get_closest_index (SCM inspect_quants) const
440 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
444 for (int i = 0; i < configurations_.size (); i++)
446 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
447 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
455 programming_error ("can't not find quant");
460 TODO: should analyse encompasses to determine sensible region, and
461 should limit slopes available.
465 Slur_score_state::get_y_attachment_range () const
467 Drul_array<Real> end_ys;
471 if (extremes_[d].note_column_)
474 * ((dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_))
475 >? (dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS],
477 >? (dir_ * base_attachments_[-d][Y_AXIS]));
480 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
482 while (flip (&d) != LEFT);
488 spanner_less (Spanner *s1, Spanner *s2)
494 b1[d] = s1->get_bound (d)->get_column ()->rank_;
495 b2[d] = s2->get_bound (d)->get_column ()->rank_;
497 while (flip (&d) != LEFT);
499 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
500 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
504 Slur_score_state::get_base_attachments () const
506 Drul_array<Offset> base_attachment;
510 Grob *stem = extremes_[d].stem_;
511 Grob *head = extremes_[d].slur_head_;
515 if (extremes_[d].note_column_)
519 fixme: X coord should also be set in this case.
522 && !Stem::is_invisible (stem)
523 && extremes_[d].stem_dir_ == dir_
524 && Stem::get_beaming (stem, -d)
525 && (!spanner_less (slur_, Stem::get_beam (stem))
527 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
529 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
530 y += dir_ * 0.5 * staff_space_;
532 y = move_away_from_staffline (y, head);
534 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
536 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
537 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
538 .linear_combination (CENTER);
540 base_attachment[d] = Offset (x, y);
542 while (flip (&d) != LEFT);
546 if (!extremes_[d].note_column_)
551 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
555 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);
582 for (int a = X_AXIS; a < NO_AXES; a++)
584 Real &b = base_attachment[d][Axis (a)];
586 if (isinf (b) || isnan (b))
588 programming_error ("slur attachment is inf/nan");
594 while (flip (&d) != LEFT);
597 return base_attachment;
601 Slur_score_state::move_away_from_staffline (Real y,
602 Grob *on_staff) const
605 = (y - Staff_symbol_referencer::get_staff_symbol (on_staff)->relative_coordinate (common_[Y_AXIS],
607 * 2.0 / staff_space_;
609 if (fabs (pos - my_round (pos)) < 0.2
610 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
611 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
612 y += 1.5 * staff_space_ * dir_ / 10;
618 Slur_score_state::generate_curves () const
620 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
621 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
622 for (int i = 0; i < configurations_.size (); i++)
623 configurations_[i]->generate_curve (*this, r_0, h_inf);
626 Link_array<Slur_configuration>
627 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
629 Link_array<Slur_configuration> scores;
631 Drul_array<Offset> os;
632 os[LEFT] = base_attachments_[LEFT];
633 Real minimum_length = staff_space_
634 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
636 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
638 os[RIGHT] = base_attachments_[RIGHT];
639 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
641 Slur_configuration s;
643 Drul_array<bool> attach_to_stem (false, false);
646 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
647 if (extremes_[d].stem_
648 && !Stem::is_invisible (extremes_[d].stem_)
649 && extremes_[d].stem_dir_ == dir_)
651 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
652 stem_y.widen (0.25 * staff_space_);
653 if (stem_y.contains (os[d][Y_AXIS]))
655 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
657 attach_to_stem[d] = true;
659 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
660 < dir_ * os[d][Y_AXIS]
661 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
663 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
666 while (flip (&d) != LEFT);
669 dz = os[RIGHT] - os[LEFT];
670 if (dz[X_AXIS] < minimum_length
671 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
675 if (extremes_[d].slur_head_)
677 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
678 attach_to_stem[d] = false;
681 while (flip (&d) != LEFT);
684 dz = os[RIGHT] - os[LEFT];
687 if (extremes_[d].slur_head_
688 && !attach_to_stem[d])
690 /* Horizontally move tilted slurs a little. Move
691 more for bigger tilts.
695 -= dir_ * extremes_[d].slur_head_extent_.length ()
696 * sin (dz.arg ()) / 3;
699 while (flip (&d) != LEFT);
702 s.index_ = scores.size ();
704 scores.push (new Slur_configuration (s));
706 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
709 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
712 assert (scores.size () > 0);
716 Array<Extra_collision_info>
717 Slur_score_state::get_extra_encompass_infos () const
719 Link_array<Grob> encompasses
720 = extract_grob_array (slur_, ly_symbol2scm ("encompass-objects"));
721 Array<Extra_collision_info> collision_infos;
722 for (int i = encompasses.size (); i--;)
724 if (Slur::has_interface (encompasses[i]))
726 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
727 Bezier b = Slur::get_curve (small_slur);
729 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
730 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
732 for (int k = 0; k < 3; k++)
734 Direction hdir = Direction (k / 2 - 1);
737 Only take bound into account if small slur starts
738 together with big slur.
740 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
743 Offset z = b.curve_point (k / 2.0);
748 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
750 Interval xext (-1, 1);
751 xext = xext * (thickness_ * 2) + z[X_AXIS];
752 Extra_collision_info info (small_slur,
756 parameters_.extra_object_collision_);
757 collision_infos.push (info);
762 Grob *g = encompasses [i];
763 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
764 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
767 Real penalty = parameters_.extra_object_collision_;
768 if (Accidental_interface::has_interface (g))
770 penalty = parameters_.accidental_collision_;
771 /* Begin copy accidental.cc */
773 if (to_boolean (g->get_property ("cautionary")))
775 SCM cstyle = g->get_property ("cautionary-style");
776 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
779 SCM accs = g->get_property ("accidentals");
780 SCM scm_style = g->get_property ("style");
781 if (!scm_is_symbol (scm_style)
783 && scm_ilength (accs) == 1)
785 /* End copy accidental.cc */
786 switch (scm_to_int (scm_car (accs)))
802 ye.widen (thickness_ * 0.5);
803 xe.widen (thickness_ * 1.0);
804 Extra_collision_info info (g, xp, xe, ye, penalty);
805 collision_infos.push (info);
809 return collision_infos;