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 - short-cut: try a smaller region first.
37 - handle non-visible stems better.
39 - try to prune number of scoring criteria
41 - take encompass-objects more into account when determining
44 - calculate encompass scoring directly after determining slur shape.
48 struct Slur_score_state;
50 Slur_score_state::Slur_score_state ()
54 edge_has_beams_ = false;
55 has_same_beam_ = false;
63 Slur_score_state::~Slur_score_state ()
65 junk_pointers (configurations_);
69 get_detail (SCM alist, SCM sym)
71 SCM entry = scm_assq (sym, alist);
72 return robust_scm2double (scm_is_pair (entry)
79 Slur_score_parameters::fill (Grob *me)
81 SCM details = me->get_property ("slur-details");
84 = (int) get_detail (details, ly_symbol2scm ("region-size"));
85 head_encompass_penalty_
86 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
87 stem_encompass_penalty_
88 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
90 = get_detail (details, ly_symbol2scm ("closeness-factor"));
91 edge_attraction_factor_
92 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
94 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
96 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
97 non_horizontal_penalty_
98 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
100 = get_detail (details, ly_symbol2scm ("max-slope"));
102 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
104 = get_detail (details, ly_symbol2scm ("free-head-distance"));
105 absolute_closeness_measure_
106 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
107 extra_object_collision_
108 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
109 accidental_collision_
110 = get_detail (details, ly_symbol2scm ("accidental-collision"));
111 extra_encompass_free_distance_
112 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
113 head_slur_distance_factor_
114 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
115 head_slur_distance_max_ratio_
116 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
118 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
120 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
124 broken_trend_y (Slur_score_state const &state, Direction hdir)
126 /* A broken slur should maintain the same vertical trend
127 the unbroken slur would have had. */
129 if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original_))
131 int k = broken_spanner_index (state.slur_);
133 if (j < 0 || j >= mother->broken_intos_.size ())
136 Grob *neighbor = mother->broken_intos_[j];
137 Spanner *common_mother
138 = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original_);
140 = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
141 int common_j = common_k + hdir;
143 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
146 Grob *common_next_system = common_mother->broken_intos_[common_j];
148 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
150 return scm_to_double (scm_cdr (last_point))
151 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
157 copy slur dir forwards across line break.
160 Slur_score_state::set_next_direction ()
162 if (extremes_[RIGHT].note_column_)
165 if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original_))
167 int k = broken_spanner_index (slur_);
169 if (j < 0 || j >= mother->broken_intos_.size ())
172 Grob *neighbor = mother->broken_intos_[j];
173 set_grob_direction (neighbor, dir_);
178 Slur_score_state::get_encompass_info (Grob *col) const
180 Grob *stem = unsmob_grob (col->get_property ("stem"));
185 programming_error ("no stem for note column");
186 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
187 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
191 Direction stem_dir = get_grob_direction (stem);
193 if (Grob *head = Note_column::first_head (col))
194 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
196 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
198 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
201 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
205 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
207 if ((stem_dir == dir_)
208 && !stem->extent (stem, Y_AXIS).is_empty ())
210 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
211 if (Grob *b = Stem::get_beam (stem))
212 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
214 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
215 ei.x_ = x.is_empty ()
216 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
225 Drul_array<Bound_info>
226 Slur_score_state::get_bound_info () const
228 Drul_array<Bound_info> extremes;
231 Direction dir = dir_;
235 extremes[d].bound_ = slur_->get_bound (d);
236 if (Note_column::has_interface (extremes[d].bound_))
238 extremes[d].note_column_ = extremes[d].bound_;
239 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
240 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
242 for (int a = X_AXIS; a < NO_AXES; a++)
245 Interval s = extremes[d].stem_->extent (common_[ax], ax);
248 programming_error ("Stem has no extent in Slur_score_state");
250 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
252 extremes[d].stem_extent_[ax] = s;
255 extremes[d].stem_extent_[Y_AXIS]
256 = extremes[d].stem_->extent (common_[Y_AXIS], Y_AXIS);
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_))
262 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 = 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 SCM eltlist = me->get_property ("note-columns");
301 SCM extra_list = me->get_property ("encompass-objects");
302 Spanner *sp = dynamic_cast<Spanner *> (me);
304 for (int i = X_AXIS; i < NO_AXES; i++)
307 common_[a] = common_refpoint_of_list (eltlist, me, a);
308 common_[a] = common_refpoint_of_list (extra_list, common_[a], a);
314 If bound is not in note-columns, we don't want to know about
318 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
320 while (flip (&d) != LEFT);
323 extremes_ = get_bound_info ();
324 is_broken_ = (!extremes_[LEFT].note_column_
325 || !extremes_[RIGHT].note_column_);
328 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
329 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
331 base_attachments_ = get_base_attachments ();
333 Drul_array<Real> end_ys
334 = get_y_attachment_range ();
336 configurations_ = enumerate_attachments (end_ys);
337 for (int i = 0; i < columns_.size (); i++)
338 encompass_infos_.push (get_encompass_info (columns_[i]));
340 extra_encompass_infos_ = get_extra_encompass_infos ();
349 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
351 while (flip (&d) != LEFT);
354 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
355 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
357 set_next_direction ();
364 set_slur_control_points (Grob *me)
366 Slur_score_state state;
372 state.generate_curves ();
374 SCM end_ys = me->get_property ("positions");
377 if (is_number_pair (end_ys))
379 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
383 best = state.get_best_curve ();
386 SCM controls = SCM_EOL;
387 for (int i = 4; i--;)
389 Offset o = best.control_[i]
390 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
391 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
392 controls = scm_cons (ly_offset2scm (o), controls);
394 me->set_property ("control-points", controls);
398 Slur_score_state::get_best_curve ()
400 for (int i = 0; i < configurations_.size (); i++)
402 configurations_[i]->score (*this);
407 for (int i = 0; i < configurations_.size (); i++)
409 if (configurations_[i]->score_ < opt)
411 opt = configurations_[i]->score_;
416 #if DEBUG_SLUR_SCORING
417 SCM inspect_quants = slur_->get_property ("inspect-quants");
418 if (to_boolean (slur_->get_layout ()
419 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
420 && scm_is_pair (inspect_quants))
421 opt_idx = get_closest_index (inspect_quants);
423 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
424 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
427 slur_->set_property ("quant-score",
428 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
432 return configurations_[opt_idx]->curve_;
436 Slur_score_state::get_closest_index (SCM inspect_quants) const
438 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
442 for (int i = 0; i < configurations_.size (); i++)
444 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
445 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
453 programming_error ("can't not find quant");
458 TODO: should analyse encompasses to determine sensible region, and
459 should limit slopes available.
463 Slur_score_state::get_y_attachment_range () const
465 Drul_array<Real> end_ys;
469 if (extremes_[d].note_column_)
472 * max (max (dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_),
473 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
474 dir_ * base_attachments_[-d][Y_AXIS]);
477 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
479 while (flip (&d) != LEFT);
485 spanner_less (Spanner *s1, Spanner *s2)
491 b1[d] = s1->get_bound (d)->get_column ()->rank_;
492 b2[d] = s2->get_bound (d)->get_column ()->rank_;
494 while (flip (&d) != LEFT);
496 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
497 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
501 Slur_score_state::get_base_attachments () const
503 Drul_array<Offset> base_attachment;
507 Grob *stem = extremes_[d].stem_;
508 Grob *head = extremes_[d].slur_head_;
512 if (extremes_[d].note_column_)
516 fixme: X coord should also be set in this case.
519 && !Stem::is_invisible (stem)
520 && extremes_[d].stem_dir_ == dir_
521 && Stem::get_beaming (stem, -d)
522 && (!spanner_less (slur_, Stem::get_beam (stem))
524 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
526 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
527 y += dir_ * 0.5 * staff_space_;
529 y = move_away_from_staffline (y, head);
531 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
533 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
534 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
535 .linear_combination (CENTER);
537 base_attachment[d] = Offset (x, y);
539 while (flip (&d) != LEFT);
543 if (!extremes_[d].note_column_)
548 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
552 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);
579 for (int a = X_AXIS; a < NO_AXES; a++)
581 Real &b = base_attachment[d][Axis (a)];
583 if (isinf (b) || isnan (b))
585 programming_error ("slur attachment is inf/nan");
591 while (flip (&d) != LEFT);
594 return base_attachment;
598 Slur_score_state::move_away_from_staffline (Real y,
599 Grob *on_staff) const
602 = (y - Staff_symbol_referencer::get_staff_symbol (on_staff)->relative_coordinate (common_[Y_AXIS],
604 * 2.0 / staff_space_;
606 if (fabs (pos - my_round (pos)) < 0.2
607 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
608 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
609 y += 1.5 * staff_space_ * dir_ / 10;
615 Slur_score_state::generate_curves () const
617 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
618 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
619 for (int i = 0; i < configurations_.size (); i++)
620 configurations_[i]->generate_curve (*this, r_0, h_inf);
623 Link_array<Slur_configuration>
624 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
626 Link_array<Slur_configuration> scores;
628 Drul_array<Offset> os;
629 os[LEFT] = base_attachments_[LEFT];
630 Real minimum_length = staff_space_
631 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
633 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
635 os[RIGHT] = base_attachments_[RIGHT];
636 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
638 Slur_configuration s;
640 Drul_array<bool> attach_to_stem (false, false);
643 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
644 if (extremes_[d].stem_
645 && !Stem::is_invisible (extremes_[d].stem_)
646 && extremes_[d].stem_dir_ == dir_)
648 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
649 stem_y.widen (0.25 * staff_space_);
650 if (stem_y.contains (os[d][Y_AXIS]))
652 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
654 attach_to_stem[d] = true;
656 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
657 < dir_ * os[d][Y_AXIS]
658 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
660 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
663 while (flip (&d) != LEFT);
666 dz = os[RIGHT] - os[LEFT];
667 if (dz[X_AXIS] < minimum_length
668 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
672 if (extremes_[d].slur_head_)
674 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
675 attach_to_stem[d] = false;
678 while (flip (&d) != LEFT);
681 dz = os[RIGHT] - os[LEFT];
684 if (extremes_[d].slur_head_
685 && !attach_to_stem[d])
687 /* Horizontally move tilted slurs a little. Move
688 more for bigger tilts.
692 -= dir_ * extremes_[d].slur_head_extent_.length ()
693 * sin (dz.arg ()) / 3;
696 while (flip (&d) != LEFT);
699 s.index_ = scores.size ();
701 scores.push (new Slur_configuration (s));
703 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
706 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
709 assert (scores.size () > 0);
713 Array<Extra_collision_info>
714 Slur_score_state::get_extra_encompass_infos () const
716 Link_array<Grob> encompasses
717 = extract_grob_array (slur_, ly_symbol2scm ("encompass-objects"));
718 Array<Extra_collision_info> collision_infos;
719 for (int i = encompasses.size (); i--;)
721 if (Slur::has_interface (encompasses[i]))
723 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
724 Bezier b = Slur::get_curve (small_slur);
726 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
727 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
729 for (int k = 0; k < 3; k++)
731 Direction hdir = Direction (k / 2 - 1);
734 Only take bound into account if small slur starts
735 together with big slur.
737 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
740 Offset z = b.curve_point (k / 2.0);
745 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
747 Interval xext (-1, 1);
748 xext = xext * (thickness_ * 2) + z[X_AXIS];
749 Extra_collision_info info (small_slur,
753 parameters_.extra_object_collision_);
754 collision_infos.push (info);
759 Grob *g = encompasses [i];
760 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
761 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
764 Real penalty = parameters_.extra_object_collision_;
765 if (Accidental_interface::has_interface (g))
767 penalty = parameters_.accidental_collision_;
768 /* Begin copy accidental.cc */
770 if (to_boolean (g->get_property ("cautionary")))
772 SCM cstyle = g->get_property ("cautionary-style");
773 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
776 SCM accs = g->get_property ("accidentals");
777 SCM scm_style = g->get_property ("style");
778 if (!scm_is_symbol (scm_style)
780 && scm_ilength (accs) == 1)
782 /* End copy accidental.cc */
783 switch (scm_to_int (scm_car (accs)))
799 ye.widen (thickness_ * 0.5);
800 xe.widen (thickness_ * 1.0);
801 Extra_collision_info info (g, xp, xe, ye, penalty);
802 collision_infos.push (info);
806 return collision_infos;