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);
249 do not issue warning. This happens for rests and
253 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
255 extremes[d].stem_extent_[ax] = s;
258 extremes[d].slur_head_
259 = Stem::extremal_heads (extremes[d].stem_)[dir];
260 if (!extremes[d].slur_head_
261 && Note_column::has_rests (extremes[d].bound_))
263 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
266 if (extremes[d].slur_head_)
267 extremes[d].slur_head_extent_
268 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
270 extremes[d].staff_ = Staff_symbol_referencer
271 ::get_staff_symbol (extremes[d].stem_);
272 extremes[d].staff_space_ = Staff_symbol_referencer
273 ::staff_space (extremes[d].stem_);
276 while (flip (&d) != LEFT);
282 Slur_score_state::fill (Grob *me)
284 slur_ = dynamic_cast<Spanner *> (me);
286 = extract_grob_array (me, ly_symbol2scm ("note-columns"));
288 if (columns_.is_empty ())
294 staff_space_ = Staff_symbol_referencer::staff_space (me);
295 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
296 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
298 dir_ = get_grob_direction (me);
299 parameters_.fill (me);
301 SCM eltlist = me->get_property ("note-columns");
302 SCM extra_list = me->get_property ("encompass-objects");
303 Spanner *sp = dynamic_cast<Spanner *> (me);
305 for (int i = X_AXIS; i < NO_AXES; i++)
308 common_[a] = common_refpoint_of_list (eltlist, me, a);
309 common_[a] = common_refpoint_of_list (extra_list, 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))
380 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
384 best = state.get_best_curve ();
387 SCM controls = SCM_EOL;
388 for (int i = 4; i--;)
390 Offset o = best.control_[i]
391 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
392 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
393 controls = scm_cons (ly_offset2scm (o), controls);
395 me->set_property ("control-points", controls);
399 Slur_score_state::get_best_curve ()
401 for (int i = 0; i < configurations_.size (); i++)
403 configurations_[i]->score (*this);
408 for (int i = 0; i < configurations_.size (); i++)
410 if (configurations_[i]->score_ < opt)
412 opt = configurations_[i]->score_;
417 #if DEBUG_SLUR_SCORING
418 SCM inspect_quants = slur_->get_property ("inspect-quants");
419 if (to_boolean (slur_->get_layout ()
420 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
421 && scm_is_pair (inspect_quants))
422 opt_idx = get_closest_index (inspect_quants);
424 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
425 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
428 slur_->set_property ("quant-score",
429 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
433 return configurations_[opt_idx]->curve_;
437 Slur_score_state::get_closest_index (SCM inspect_quants) const
439 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
443 for (int i = 0; i < configurations_.size (); i++)
445 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
446 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
454 programming_error ("can't not find quant");
459 TODO: should analyse encompasses to determine sensible region, and
460 should limit slopes available.
464 Slur_score_state::get_y_attachment_range () const
466 Drul_array<Real> end_ys;
470 if (extremes_[d].note_column_)
473 * max (max (dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_),
474 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
475 dir_ * base_attachments_[-d][Y_AXIS]);
478 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
480 while (flip (&d) != LEFT);
486 spanner_less (Spanner *s1, Spanner *s2)
492 b1[d] = s1->get_bound (d)->get_column ()->rank_;
493 b2[d] = s2->get_bound (d)->get_column ()->rank_;
495 while (flip (&d) != LEFT);
497 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
498 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
502 Slur_score_state::get_base_attachments () const
504 Drul_array<Offset> base_attachment;
508 Grob *stem = extremes_[d].stem_;
509 Grob *head = extremes_[d].slur_head_;
513 if (extremes_[d].note_column_)
517 fixme: X coord should also be set in this case.
520 && !Stem::is_invisible (stem)
521 && extremes_[d].stem_dir_ == dir_
522 && Stem::get_beaming (stem, -d)
523 && (!spanner_less (slur_, Stem::get_beam (stem))
525 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
527 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
528 y += dir_ * 0.5 * staff_space_;
530 y = move_away_from_staffline (y, head);
532 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
534 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
535 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
536 .linear_combination (CENTER);
538 base_attachment[d] = Offset (x, y);
540 while (flip (&d) != LEFT);
544 if (!extremes_[d].note_column_)
549 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
553 x = slur_->get_broken_left_end_align ();
555 Grob *col = (d == LEFT) ? columns_[0] : columns_.top ();
557 if (extremes_[-d].bound_ != col)
559 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
560 y += dir_ * 0.5 * staff_space_;
562 if (get_grob_direction (col) == dir_
563 && Note_column::get_stem (col)
564 && !Stem::is_invisible (Note_column::get_stem (col)))
565 y -= dir_ * 1.5 * staff_space_;
568 y = base_attachment[-d][Y_AXIS];
570 y = move_away_from_staffline (y, col);
572 base_attachment[d] = Offset (x, y);
575 while (flip (&d) != LEFT);
580 for (int a = X_AXIS; a < NO_AXES; a++)
582 Real &b = base_attachment[d][Axis (a)];
584 if (isinf (b) || isnan (b))
586 programming_error ("slur attachment is inf/nan");
592 while (flip (&d) != LEFT);
595 return base_attachment;
599 Slur_score_state::move_away_from_staffline (Real y,
600 Grob *on_staff) const
602 Grob * staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
607 = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
609 * 2.0 / staff_space_;
611 if (fabs (pos - my_round (pos)) < 0.2
612 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
613 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
614 y += 1.5 * staff_space_ * dir_ / 10;
620 Slur_score_state::generate_curves () const
622 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
623 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
624 for (int i = 0; i < configurations_.size (); i++)
625 configurations_[i]->generate_curve (*this, r_0, h_inf);
628 Link_array<Slur_configuration>
629 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
631 Link_array<Slur_configuration> scores;
633 Drul_array<Offset> os;
634 os[LEFT] = base_attachments_[LEFT];
635 Real minimum_length = staff_space_
636 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
638 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
640 os[RIGHT] = base_attachments_[RIGHT];
641 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
643 Slur_configuration s;
645 Drul_array<bool> attach_to_stem (false, false);
648 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
649 if (extremes_[d].stem_
650 && !Stem::is_invisible (extremes_[d].stem_)
651 && extremes_[d].stem_dir_ == dir_)
653 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
654 stem_y.widen (0.25 * staff_space_);
655 if (stem_y.contains (os[d][Y_AXIS]))
657 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
659 attach_to_stem[d] = true;
661 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
662 < dir_ * os[d][Y_AXIS]
663 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
665 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
668 while (flip (&d) != LEFT);
671 dz = os[RIGHT] - os[LEFT];
672 if (dz[X_AXIS] < minimum_length
673 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
677 if (extremes_[d].slur_head_)
679 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
680 attach_to_stem[d] = false;
683 while (flip (&d) != LEFT);
686 dz = os[RIGHT] - os[LEFT];
689 if (extremes_[d].slur_head_
690 && !attach_to_stem[d])
692 /* Horizontally move tilted slurs a little. Move
693 more for bigger tilts.
697 -= dir_ * extremes_[d].slur_head_extent_.length ()
698 * sin (dz.arg ()) / 3;
701 while (flip (&d) != LEFT);
704 s.index_ = scores.size ();
706 scores.push (new Slur_configuration (s));
708 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
711 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
714 assert (scores.size () > 0);
718 Array<Extra_collision_info>
719 Slur_score_state::get_extra_encompass_infos () const
721 Link_array<Grob> encompasses
722 = extract_grob_array (slur_, ly_symbol2scm ("encompass-objects"));
723 Array<Extra_collision_info> collision_infos;
724 for (int i = encompasses.size (); i--;)
726 if (Slur::has_interface (encompasses[i]))
728 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
729 Bezier b = Slur::get_curve (small_slur);
731 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
732 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
734 for (int k = 0; k < 3; k++)
736 Direction hdir = Direction (k / 2 - 1);
739 Only take bound into account if small slur starts
740 together with big slur.
742 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
745 Offset z = b.curve_point (k / 2.0);
750 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
752 Interval xext (-1, 1);
753 xext = xext * (thickness_ * 2) + z[X_AXIS];
754 Extra_collision_info info (small_slur,
758 parameters_.extra_object_collision_);
759 collision_infos.push (info);
764 Grob *g = encompasses [i];
765 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
766 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
769 Real penalty = parameters_.extra_object_collision_;
770 if (Accidental_interface::has_interface (g))
772 penalty = parameters_.accidental_collision_;
773 /* Begin copy accidental.cc */
775 if (to_boolean (g->get_property ("cautionary")))
777 SCM cstyle = g->get_property ("cautionary-style");
778 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
781 SCM accs = g->get_property ("accidentals");
782 SCM scm_style = g->get_property ("style");
783 if (!scm_is_symbol (scm_style)
785 && scm_ilength (accs) == 1)
787 /* End copy accidental.cc */
788 switch (scm_to_int (scm_car (accs)))
804 ye.widen (thickness_ * 0.5);
805 xe.widen (thickness_ * 1.0);
806 Extra_collision_info info (g, xp, xe, ye, penalty);
807 collision_infos.push (info);
811 return collision_infos;