2 slur-scoring.cc -- Score based slur formatting
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 #include "libc-extension.hh"
13 #include "slur-configuration.hh"
14 #include "slur-scoring.hh"
16 #include "directional-element-interface.hh"
17 #include "group-interface.hh"
18 #include "lily-guile.hh"
20 #include "note-column.hh"
21 #include "output-def.hh"
25 #include "staff-symbol-referencer.hh"
26 #include "staff-symbol.hh"
29 #include "paper-column.hh"
30 #include "accidental-interface.hh"
35 - curve around flag for y coordinate
37 - this file is a mess, clean it up
39 - short-cut: try a smaller region first.
41 - handle non-visible stems better.
43 - try to prune number of scoring criteria
45 - take encompass-objects more into account when determining
48 - calculate encompass scoring directly after determining slur shape.
53 struct Slur_score_state;
55 Slur_score_state::Slur_score_state()
59 edge_has_beams_ = false;
60 has_same_beam_ = false;
68 Slur_score_state::~Slur_score_state ()
70 junk_pointers (configurations_);
74 get_detail (SCM alist, SCM sym)
76 SCM entry = scm_assq (sym, alist);
77 return robust_scm2double (scm_is_pair (entry)
84 Slur_score_parameters::fill (Grob *me)
86 SCM details = me->get_property ("slur-details");
89 = (int) get_detail (details, ly_symbol2scm ("region-size"));
90 head_encompass_penalty_
91 = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
92 stem_encompass_penalty_
93 = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
95 = get_detail (details, ly_symbol2scm ("closeness-factor"));
96 edge_attraction_factor_
97 = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
99 = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
100 steeper_slope_factor_
101 = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
102 non_horizontal_penalty_
103 = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
105 = get_detail (details, ly_symbol2scm ("max-slope"));
107 = get_detail (details, ly_symbol2scm ("max-slope-factor"));
109 = get_detail (details, ly_symbol2scm ("free-head-distance"));
110 absolute_closeness_measure_
111 = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
112 extra_object_collision_
113 = get_detail (details, ly_symbol2scm ("extra-object-collision"));
114 accidental_collision_
115 = get_detail (details, ly_symbol2scm ("accidental-collision"));
116 extra_encompass_free_distance_
117 = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
118 head_slur_distance_factor_
119 = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
120 head_slur_distance_max_ratio_
121 = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
123 = get_detail (details, ly_symbol2scm ("free-slur-distance"));
125 = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
129 broken_trend_y (Slur_score_state const &state, Direction hdir)
131 /* A broken slur should maintain the same vertical trend
132 the unbroken slur would have had. */
134 if (Spanner *mother = dynamic_cast<Spanner*> (state.slur_->original_))
136 int k = broken_spanner_index (state.slur_);
138 if (j < 0 || j >= mother->broken_intos_.size ())
141 Grob *neighbor = mother->broken_intos_[j];
142 Spanner *common_mother
143 = dynamic_cast<Spanner*> (state.common_[Y_AXIS]->original_);
145 = broken_spanner_index (dynamic_cast<Spanner*> (state.common_[Y_AXIS]));
146 int common_j = common_k + hdir;
148 if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
151 Grob *common_next_system = common_mother->broken_intos_[common_j];
153 SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
155 return scm_to_double (scm_cdr (last_point))
156 + neighbor->relative_coordinate (common_next_system, Y_AXIS);
163 copy slur dir forwards across line break.
166 Slur_score_state::set_next_direction ()
168 if (extremes_[RIGHT].note_column_)
171 if (Spanner *mother = dynamic_cast<Spanner*> (slur_->original_))
173 int k = broken_spanner_index (slur_);
175 if (j < 0 || j >= mother->broken_intos_.size ())
178 Grob *neighbor = mother->broken_intos_[j];
179 set_grob_direction (neighbor, dir_);
184 Slur_score_state::get_encompass_info (Grob *col) const
186 Grob *stem = unsmob_grob (col->get_property ("stem"));
191 programming_error ("No stem for note column?");
192 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
193 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
197 Direction stem_dir = get_grob_direction (stem);
199 if (Grob *head = Note_column::first_head (col))
200 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
202 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
204 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
207 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
211 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
213 if ((stem_dir == dir_)
214 && !stem->extent (stem, Y_AXIS).is_empty ())
216 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
217 if (Grob *b = Stem::get_beam (stem))
218 ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
220 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
221 ei.x_ = x.is_empty ()
222 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
234 Drul_array<Bound_info>
235 Slur_score_state::get_bound_info () const
237 Drul_array<Bound_info> extremes;
240 Direction dir = dir_;
244 extremes[d].bound_ = slur_->get_bound (d);
245 if (Note_column::has_interface (extremes[d].bound_))
247 extremes[d].note_column_ = extremes[d].bound_;
248 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
249 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
250 extremes[d].stem_extent_[X_AXIS]
251 = extremes[d].stem_->extent (common_[X_AXIS], X_AXIS);
252 extremes[d].stem_extent_[Y_AXIS]
253 = extremes[d].stem_->extent (common_[Y_AXIS], Y_AXIS);
254 extremes[d].slur_head_
255 = Stem::extremal_heads (extremes[d].stem_)[dir];
256 if (!extremes[d].slur_head_
257 && Note_column::has_rests (extremes[d].bound_))
259 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
262 if (extremes[d].slur_head_)
263 extremes[d].slur_head_extent_
264 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
266 extremes[d].staff_ = Staff_symbol_referencer
267 ::get_staff_symbol (extremes[d].stem_);
268 extremes[d].staff_space_ = Staff_symbol_referencer
269 ::staff_space (extremes[d].stem_);
272 while (flip (&d) != LEFT);
277 Slur_score_state::fill (Grob *me)
279 slur_ = dynamic_cast<Spanner*> (me);
281 = Pointer_group_interface__extract_grobs (me, (Grob *) 0, "note-columns");
283 if (columns_.is_empty ())
289 staff_space_ = Staff_symbol_referencer::staff_space (me);
290 Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
291 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
293 dir_ = get_grob_direction (me);
294 parameters_.fill (me);
296 SCM eltlist = me->get_property ("note-columns");
297 SCM extra_list = me->get_property ("encompass-objects");
298 Spanner *sp = dynamic_cast<Spanner*> (me);
300 for (int i = X_AXIS; i < NO_AXES; i++)
303 common_[a] = common_refpoint_of_list (eltlist, me, a);
304 common_[a] = common_refpoint_of_list (extra_list, common_[a], a);
309 If bound is not in note-columns, we don't want to know about
313 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
315 while (flip (&d) != LEFT);
318 extremes_ = get_bound_info ();
319 is_broken_ = (!extremes_[LEFT].note_column_
320 || !extremes_[RIGHT].note_column_);
323 (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
324 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
326 base_attachments_ = get_base_attachments ();
328 Drul_array<Real> end_ys
329 = get_y_attachment_range ();
331 configurations_ = enumerate_attachments ( end_ys);
332 for (int i = 0; i < columns_.size (); i++)
333 encompass_infos_.push (get_encompass_info ( columns_[i]));
335 extra_encompass_infos_ = get_extra_encompass_infos ();
345 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
347 while (flip (&d) != LEFT);
350 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
351 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
355 set_next_direction ();
362 set_slur_control_points (Grob *me)
364 Slur_score_state state;
370 state.generate_curves ();
372 SCM end_ys = me->get_property ("positions");
375 if (is_number_pair (end_ys))
377 best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
381 best = state.get_best_curve();
384 SCM controls = SCM_EOL;
385 for (int i = 4; i--;)
387 Offset o = best.control_[i]
388 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
389 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
390 controls = scm_cons (ly_offset2scm (o), controls);
392 me->set_property ("control-points", controls);
397 Slur_score_state::get_best_curve ()
399 for (int i = 0; i < configurations_.size (); i++)
401 configurations_[i]->score (*this);
406 for (int i = 0; i < configurations_.size (); i++)
408 if (configurations_[i]->score_ < opt)
410 opt = configurations_[i]->score_;
415 #if DEBUG_SLUR_SCORING
416 SCM inspect_quants = slur_->get_property ("inspect-quants");
417 if (to_boolean (slur_->get_layout ()
418 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
419 && scm_is_pair (inspect_quants))
420 opt_idx = get_closest_index (inspect_quants);
422 configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
423 configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
426 slur_->set_property ("quant-score",
427 scm_makfrom0str (configurations_[opt_idx]->score_card_.to_str0 ()));
431 return configurations_[opt_idx]->curve_;
435 Slur_score_state::get_closest_index (SCM inspect_quants) const
437 Drul_array<Real> ins = ly_scm2interval (inspect_quants);
441 for (int i = 0; i < configurations_.size (); i ++)
443 Real d =fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
444 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
452 programming_error ("Could not find quant.");
457 TODO: should analyse encompasses to determine sensible region, and
458 should limit slopes available.
462 Slur_score_state::get_y_attachment_range () const
464 Drul_array<Real> end_ys;
468 if (extremes_[d].note_column_)
471 * ((dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_* dir_))
472 >? (dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS],
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_;
493 } while (flip (&d) != LEFT);
495 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
496 && (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 && extremes_[d].stem_dir_ == dir_
520 && Stem::get_beaming (stem, -d)
521 && (!spanner_less (slur_, Stem::get_beam (stem))
523 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
525 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
526 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];
570 y = move_away_from_staffline (y, col);
572 base_attachment[d] = Offset (x, y);
575 while (flip (&d) != LEFT);
577 return base_attachment;
581 Slur_score_state::move_away_from_staffline (Real y,
582 Grob *on_staff) const
585 = (y - Staff_symbol_referencer::get_staff_symbol (on_staff)->relative_coordinate (common_[Y_AXIS],
587 * 2.0 / staff_space_;
589 if (fabs (pos - my_round (pos)) < 0.2
590 && Staff_symbol_referencer::on_staffline (on_staff, (int) rint (pos))
591 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos)
593 y += 1.5 * staff_space_ * dir_ / 10;
599 Slur_score_state::generate_curves () const
601 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
602 Real h_inf = staff_space_ *scm_to_double (slur_->get_property ("height-limit"));
603 for (int i = 0; i < configurations_.size (); i++)
604 configurations_[i]->generate_curve (*this, r_0, h_inf);
610 Link_array<Slur_configuration>
611 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
614 Link_array<Slur_configuration> scores;
617 Drul_array<Offset> os;
618 os[LEFT] = base_attachments_[LEFT];
619 Real minimum_length = staff_space_
620 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
622 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
624 os[RIGHT] = base_attachments_[RIGHT];
625 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
627 Slur_configuration s;
629 Drul_array<bool> attach_to_stem (false, false);
632 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
633 if (extremes_[d].stem_
634 && !Stem::is_invisible (extremes_[d].stem_)
635 && extremes_[d].stem_dir_ == dir_)
637 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
638 stem_y.widen (0.25 * staff_space_);
639 if (stem_y.contains (os[d][Y_AXIS]))
641 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
643 attach_to_stem[d] = true;
645 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
646 < dir_ * os[d][Y_AXIS]
647 && !extremes_[d].stem_extent_[X_AXIS].is_empty ()
650 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
653 while (flip (&d) != LEFT);
656 dz = os[RIGHT] - os[LEFT];
657 if (dz[X_AXIS] < minimum_length
658 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_
663 if (extremes_[d].slur_head_)
665 os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
666 attach_to_stem[d] = false;
669 while (flip (&d) != LEFT);
672 dz = os[RIGHT] - os[LEFT];
675 if (extremes_[d].slur_head_
676 && !attach_to_stem[d])
678 /* Horizontally move tilted slurs a little. Move
679 more for bigger tilts.
683 -= dir_ * extremes_[d].slur_head_extent_.length ()
684 * sin (dz.arg ()) / 3;
687 while (flip (&d) != LEFT);
690 s.index_ = scores.size ();
692 scores.push (new Slur_configuration (s));
694 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
697 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
700 assert (scores.size () > 0);
705 Array<Extra_collision_info>
706 Slur_score_state::get_extra_encompass_infos () const
708 Link_array<Grob> encompasses
709 = Pointer_group_interface__extract_grobs (slur_, (Grob *)0,
710 "encompass-objects");
711 Array<Extra_collision_info> collision_infos;
712 for (int i = encompasses.size (); i--; )
714 if (Slur::has_interface (encompasses[i]))
716 Spanner * small_slur = dynamic_cast<Spanner*> (encompasses[i]);
717 Bezier b = Slur::get_curve (small_slur);
719 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
720 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
722 for (int k = 0; k < 3; k++)
724 Direction hdir = Direction (k /2 - 1);
727 Only take bound into account if small slur starts
728 together with big slur.
730 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
733 Offset z = b.curve_point (k / 2.0);
738 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
740 Interval xext (-1, 1);
741 xext = xext * (thickness_*2) + z[X_AXIS];
742 Extra_collision_info info (small_slur,
746 parameters_.extra_object_collision_);
747 collision_infos.push (info);
752 Grob *g = encompasses [i];
753 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
754 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
757 Real penalty = parameters_.extra_object_collision_;
758 if (Accidental_interface::has_interface (g))
760 penalty = parameters_.accidental_collision_;
761 /* Begin copy accidental.cc */
763 if (to_boolean (g->get_property ("cautionary")))
765 SCM cstyle = g->get_property ("cautionary-style");
766 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
769 SCM accs = g->get_property ("accidentals");
770 SCM scm_style = g->get_property ("style");
771 if (!scm_is_symbol (scm_style)
773 && scm_ilength (accs) == 1)
775 /* End copy accidental.cc */
776 switch (scm_to_int (scm_car (accs)))
792 ye.widen (thickness_ * 0.5);
793 xe.widen (thickness_ * 1.0);
794 Extra_collision_info info (g, xp, xe, ye, penalty);
795 collision_infos.push (info);
799 return collision_infos;