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 "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 - this file is a mess, clean it up
38 - short-cut: try a smaller region first.
40 - handle non-visible stems better.
42 - try to prune number of scoring criteria
44 - take encompass-objects more into account when determining
47 - calculate encompass scoring directly after determining slur shape.
52 struct Slur_score_state;
54 Slur_score_state::Slur_score_state()
58 edge_has_beams_ = false;
59 has_same_beam_ = false;
67 Slur_score_state::~Slur_score_state ()
69 junk_pointers (configurations_);
73 get_detail (SCM alist, SCM sym)
75 SCM entry = scm_assq (sym, alist);
76 return robust_scm2double (scm_is_pair (entry)
83 Slur_score_parameters::fill (Grob *me)
85 SCM details = me->get_property ("slur-details");
88 = (int) get_detail (details, ly_symbol2scm ("region-size"));
89 head_encompass_penalty_
90 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
91 stem_encompass_penalty_
92 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
94 = get_detail (details, ly_symbol2scm ("closeness-factor"));
95 edge_attraction_factor_
96 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
98 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
100 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
101 non_horizontal_penalty_
102 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
104 = get_detail (details, ly_symbol2scm ("max-slope"));
106 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
108 = get_detail (details, ly_symbol2scm ("free-head-distance"));
109 absolute_closeness_measure_
110 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
111 extra_object_collision_
112 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
113 accidental_collision_
114 = get_detail (details, ly_symbol2scm ("accidental-collision"));
115 extra_encompass_free_distance_
116 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
117 head_slur_distance_factor_
118 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
119 head_slur_distance_max_ratio_
120 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
122 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
124 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
128 broken_trend_y (Slur_score_state const &state, Direction hdir)
130 /* A broken slur should maintain the same vertical trend
131 the unbroken slur would have had. */
133 if (Spanner *mother = dynamic_cast<Spanner*> (state.slur_->original_))
135 int k = broken_spanner_index (state.slur_);
137 if (j < 0 || j >= mother->broken_intos_.size ())
140 Grob *neighbor = mother->broken_intos_[j];
141 Spanner *common_mother
142 = dynamic_cast<Spanner*> (state.common_[Y_AXIS]->original_);
144 = broken_spanner_index (dynamic_cast<Spanner*> (state.common_[Y_AXIS]));
145 int common_j = common_k + hdir;
147 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
150 Grob *common_next_system = common_mother->broken_intos_[common_j];
152 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
154 return scm_to_double (scm_cdr (last_point))
155 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
162 copy slur dir forwards across line break.
165 Slur_score_state::set_next_direction ()
167 if (extremes_[RIGHT].note_column_)
170 if (Spanner *mother = dynamic_cast<Spanner*> (slur_->original_))
172 int k = broken_spanner_index (slur_);
174 if (j < 0 || j >= mother->broken_intos_.size ())
177 Grob *neighbor = mother->broken_intos_[j];
178 set_grob_direction (neighbor, dir_);
183 Slur_score_state::get_encompass_info (Grob *col) const
185 Grob *stem = unsmob_grob (col->get_property ("stem"));
190 programming_error ("No stem for note column?");
191 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
192 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
196 Direction stem_dir = get_grob_direction (stem);
198 if (Grob *head = Note_column::first_head (col))
199 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
201 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
203 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
206 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
210 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
212 if ((stem_dir == dir_)
213 && !stem->extent (stem, Y_AXIS).is_empty ())
215 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
216 if (Grob *b = Stem::get_beam (stem))
217 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
219 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
220 ei.x_ = x.is_empty ()
221 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
233 Drul_array<Bound_info>
234 Slur_score_state::get_bound_info () const
236 Drul_array<Bound_info> extremes;
239 Direction dir = dir_;
243 extremes[d].bound_ = slur_->get_bound (d);
244 if (Note_column::has_interface (extremes[d].bound_))
246 extremes[d].note_column_ = extremes[d].bound_;
247 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
248 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
249 extremes[d].stem_extent_[X_AXIS]
250 = extremes[d].stem_->extent (common_[X_AXIS], X_AXIS);
251 extremes[d].stem_extent_[Y_AXIS]
252 = extremes[d].stem_->extent (common_[Y_AXIS], Y_AXIS);
253 extremes[d].slur_head_
254 = Stem::extremal_heads (extremes[d].stem_)[dir];
255 if (!extremes[d].slur_head_
256 && Note_column::has_rests (extremes[d].bound_))
258 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
261 if (extremes[d].slur_head_)
262 extremes[d].slur_head_extent_
263 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
265 extremes[d].staff_ = Staff_symbol_referencer
266 ::get_staff_symbol (extremes[d].stem_);
267 extremes[d].staff_space_ = Staff_symbol_referencer
268 ::staff_space (extremes[d].stem_);
271 while (flip (&d) != LEFT);
276 Slur_score_state::fill (Grob *me)
278 slur_ = dynamic_cast<Spanner*> (me);
280 = extract_grob_array (me, ly_symbol2scm ("note-columns"));
282 if (columns_.is_empty ())
288 staff_space_ = Staff_symbol_referencer::staff_space (me);
289 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
290 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
292 dir_ = get_grob_direction (me);
293 parameters_.fill (me);
295 SCM eltlist = me->get_property ("note-columns");
296 SCM extra_list = me->get_property ("encompass-objects");
297 Spanner *sp = dynamic_cast<Spanner*> (me);
299 for (int i = X_AXIS; i < NO_AXES; i++)
302 common_[a] = common_refpoint_of_list (eltlist, me, a);
303 common_[a] = common_refpoint_of_list (extra_list, common_[a], a);
308 If bound is not in note-columns, we don't want to know about
312 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
314 while (flip (&d) != LEFT);
317 extremes_ = get_bound_info ();
318 is_broken_ = (!extremes_[LEFT].note_column_
319 || !extremes_[RIGHT].note_column_);
322 (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
323 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
325 base_attachments_ = get_base_attachments ();
327 Drul_array<Real> end_ys
328 = get_y_attachment_range ();
330 configurations_ = enumerate_attachments ( end_ys);
331 for (int i = 0; i < columns_.size (); i++)
332 encompass_infos_.push (get_encompass_info ( columns_[i]));
334 extra_encompass_infos_ = get_extra_encompass_infos ();
344 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
346 while (flip (&d) != LEFT);
349 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
350 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
354 set_next_direction ();
361 set_slur_control_points (Grob *me)
363 Slur_score_state state;
369 state.generate_curves ();
371 SCM end_ys = me->get_property ("positions");
374 if (is_number_pair (end_ys))
376 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
380 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);
396 Slur_score_state::get_best_curve ()
398 for (int i = 0; i < configurations_.size (); i++)
400 configurations_[i]->score (*this);
405 for (int i = 0; i < configurations_.size (); i++)
407 if (configurations_[i]->score_ < opt)
409 opt = configurations_[i]->score_;
414 #if DEBUG_SLUR_SCORING
415 SCM inspect_quants = slur_->get_property ("inspect-quants");
416 if (to_boolean (slur_->get_layout ()
417 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
418 && scm_is_pair (inspect_quants))
419 opt_idx = get_closest_index (inspect_quants);
421 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
422 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
425 slur_->set_property ("quant-score",
426 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
430 return configurations_[opt_idx]->curve_;
434 Slur_score_state::get_closest_index (SCM inspect_quants) const
436 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
440 for (int i = 0; i < configurations_.size (); i ++)
442 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
443 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
451 programming_error ("Could not find quant.");
456 TODO: should analyse encompasses to determine sensible region, and
457 should limit slopes available.
461 Slur_score_state::get_y_attachment_range () const
463 Drul_array<Real> end_ys;
467 if (extremes_[d].note_column_)
470 * ((dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_* dir_))
471 >? (dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS],
473 >? (dir_ * base_attachments_[-d][Y_AXIS]));
476 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
478 while (flip (&d) != LEFT);
484 spanner_less (Spanner *s1, Spanner* s2)
490 b1[d] = s1->get_bound (d)->get_column ()->rank_;
491 b2[d] = s2->get_bound (d)->get_column ()->rank_;
492 } while (flip (&d) != LEFT);
494 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
495 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
500 Slur_score_state::get_base_attachments () const
502 Drul_array<Offset> base_attachment;
506 Grob *stem = extremes_[d].stem_;
507 Grob *head = extremes_[d].slur_head_;
511 if (extremes_[d].note_column_)
515 fixme: X coord should also be set in this case.
518 && extremes_[d].stem_dir_ == dir_
519 && Stem::get_beaming (stem, -d)
520 && (!spanner_less (slur_, Stem::get_beam (stem))
522 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
524 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
525 y += dir_ * 0.5 * staff_space_;
528 y = move_away_from_staffline (y, head);
530 Grob * fh = Note_column::first_head (extremes_[d].note_column_);
532 (fh ? fh->extent (common_[X_AXIS], X_AXIS)
533 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
534 .linear_combination (CENTER);
536 base_attachment[d] = Offset (x, y);
538 } while (flip (&d) != LEFT);
542 if (!extremes_[d].note_column_)
547 x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
551 x = slur_->get_broken_left_end_align ();
553 Grob * col = (d == LEFT) ? columns_[0] : columns_.top();
555 if (extremes_[-d].bound_ != col)
557 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
558 y += dir_ * 0.5 * staff_space_;
560 if (get_grob_direction (col) == dir_
561 && Note_column::get_stem (col)
562 && !Stem::is_invisible (Note_column::get_stem (col)))
563 y -= dir_ * 1.5 * staff_space_;
566 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);
576 return base_attachment;
580 Slur_score_state::move_away_from_staffline (Real y,
581 Grob *on_staff) const
584 = (y - Staff_symbol_referencer::get_staff_symbol (on_staff)->relative_coordinate (common_[Y_AXIS],
586 * 2.0 / staff_space_;
588 if (fabs (pos - my_round (pos)) < 0.2
589 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
590 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos)
592 y += 1.5 * staff_space_ * dir_ / 10;
598 Slur_score_state::generate_curves () const
600 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
601 Real h_inf = staff_space_ *scm_to_double (slur_->get_property ("height-limit"));
602 for (int i = 0; i < configurations_.size (); i++)
603 configurations_[i]->generate_curve (*this, r_0, h_inf);
609 Link_array<Slur_configuration>
610 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
613 Link_array<Slur_configuration> scores;
616 Drul_array<Offset> os;
617 os[LEFT] = base_attachments_[LEFT];
618 Real minimum_length = staff_space_
619 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
621 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
623 os[RIGHT] = base_attachments_[RIGHT];
624 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
626 Slur_configuration s;
628 Drul_array<bool> attach_to_stem (false, false);
631 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
632 if (extremes_[d].stem_
633 && !Stem::is_invisible (extremes_[d].stem_)
634 && extremes_[d].stem_dir_ == dir_)
636 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
637 stem_y.widen (0.25 * staff_space_);
638 if (stem_y.contains (os[d][Y_AXIS]))
640 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
642 attach_to_stem[d] = true;
644 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
645 < dir_ * os[d][Y_AXIS]
646 && !extremes_[d].stem_extent_[X_AXIS].is_empty ()
649 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
652 while (flip (&d) != LEFT);
655 dz = os[RIGHT] - os[LEFT];
656 if (dz[X_AXIS] < minimum_length
657 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_
662 if (extremes_[d].slur_head_)
664 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
665 attach_to_stem[d] = false;
668 while (flip (&d) != LEFT);
671 dz = os[RIGHT] - os[LEFT];
674 if (extremes_[d].slur_head_
675 && !attach_to_stem[d])
677 /* Horizontally move tilted slurs a little. Move
678 more for bigger tilts.
682 -= dir_ * extremes_[d].slur_head_extent_.length ()
683 * sin (dz.arg ()) / 3;
686 while (flip (&d) != LEFT);
689 s.index_ = scores.size ();
691 scores.push (new Slur_configuration (s));
693 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
696 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
699 assert (scores.size () > 0);
704 Array<Extra_collision_info>
705 Slur_score_state::get_extra_encompass_infos () const
707 Link_array<Grob> encompasses
708 = extract_grob_array (slur_, ly_symbol2scm ("encompass-objects"));
709 Array<Extra_collision_info> collision_infos;
710 for (int i = encompasses.size (); i--; )
712 if (Slur::has_interface (encompasses[i]))
714 Spanner * small_slur = dynamic_cast<Spanner*> (encompasses[i]);
715 Bezier b = Slur::get_curve (small_slur);
717 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
718 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
720 for (int k = 0; k < 3; k++)
722 Direction hdir = Direction (k /2 - 1);
725 Only take bound into account if small slur starts
726 together with big slur.
728 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
731 Offset z = b.curve_point (k / 2.0);
736 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
738 Interval xext (-1, 1);
739 xext = xext * (thickness_*2) + z[X_AXIS];
740 Extra_collision_info info (small_slur,
744 parameters_.extra_object_collision_);
745 collision_infos.push (info);
750 Grob *g = encompasses [i];
751 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
752 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
755 Real penalty = parameters_.extra_object_collision_;
756 if (Accidental_interface::has_interface (g))
758 penalty = parameters_.accidental_collision_;
759 /* Begin copy accidental.cc */
761 if (to_boolean (g->get_property ("cautionary")))
763 SCM cstyle = g->get_property ("cautionary-style");
764 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
767 SCM accs = g->get_property ("accidentals");
768 SCM scm_style = g->get_property ("style");
769 if (!scm_is_symbol (scm_style)
771 && scm_ilength (accs) == 1)
773 /* End copy accidental.cc */
774 switch (scm_to_int (scm_car (accs)))
790 ye.widen (thickness_ * 0.5);
791 xe.widen (thickness_ * 1.0);
792 Extra_collision_info info (g, xp, xe, ye, penalty);
793 collision_infos.push (info);
797 return collision_infos;