2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1996--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
5 Jan Nieuwenhuizen <janneke@gnu.org>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "slur-scoring.hh"
25 #include "accidental-interface.hh"
28 #include "directional-element-interface.hh"
30 #include "libc-extension.hh"
33 #include "note-column.hh"
34 #include "output-def.hh"
35 #include "paper-column.hh"
37 #include "pointer-group-interface.hh"
38 #include "slur-configuration.hh"
41 #include "staff-symbol-referencer.hh"
42 #include "staff-symbol.hh"
44 #include "time-signature.hh"
50 - curve around flag for y coordinate
52 - short-cut: try a smaller region first.
54 - handle non-visible stems better.
56 - try to prune number of scoring criteria
58 - take encompass-objects more into account when determining
61 - calculate encompass scoring directly after determining slur shape.
65 struct Slur_score_state;
67 Slur_score_state::Slur_score_state ()
71 edge_has_beams_ = false;
72 has_same_beam_ = false;
80 Slur_score_state::~Slur_score_state ()
82 junk_pointers (configurations_);
86 If a slur is broken across a line break, the direction
87 of the post-break slur must be the same as the pre-break
91 Slur_score_state::slur_direction () const
93 Grob *left_neighbor = slur_->broken_neighbor (LEFT);
95 if (left_neighbor && left_neighbor->is_live ())
96 return get_grob_direction (left_neighbor);
98 Direction dir = get_grob_direction (slur_);
100 if (Grob *right_neighbor = slur_->broken_neighbor (RIGHT))
101 set_grob_direction (right_neighbor, dir);
107 Slur_score_state::get_encompass_info (Grob *col) const
109 Grob *stem = unsmob_grob (col->get_object ("stem"));
114 programming_error ("no stem for note column");
115 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
116 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
120 Direction stem_dir = get_grob_direction (stem);
122 if (Grob *head = Note_column::first_head (col))
123 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
125 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
127 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
130 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
134 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
136 if ((stem_dir == dir_)
137 && !stem->extent (stem, Y_AXIS).is_empty ())
139 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
140 if (Grob *b = Stem::get_beam (stem))
141 ei.stem_ += stem_dir * 0.5 * Beam::get_beam_thickness (b);
143 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
144 ei.x_ = x.is_empty ()
145 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
154 Drul_array<Bound_info>
155 Slur_score_state::get_bound_info () const
157 Drul_array<Bound_info> extremes;
159 Direction dir = dir_;
161 for (LEFT_and_RIGHT (d))
163 extremes[d].bound_ = slur_->get_bound (d);
164 if (Note_column::has_interface (extremes[d].bound_))
166 extremes[d].note_column_ = extremes[d].bound_;
167 extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
168 if (extremes[d].stem_)
170 extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
172 for (int a = X_AXIS; a < NO_AXES; a++)
175 Interval s = extremes[d].stem_->extent (common_[ax], ax);
179 do not issue warning. This happens for rests and
183 + extremes[d].stem_->relative_coordinate (common_[ax], ax);
185 extremes[d].stem_extent_[ax] = s;
188 extremes[d].slur_head_
189 = Stem::extremal_heads (extremes[d].stem_)[dir];
190 if (!extremes[d].slur_head_
191 && Note_column::has_rests (extremes[d].bound_))
192 extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
193 extremes[d].staff_ = Staff_symbol_referencer
194 ::get_staff_symbol (extremes[d].stem_);
195 extremes[d].staff_space_ = Staff_symbol_referencer
196 ::staff_space (extremes[d].stem_);
199 if (extremes[d].slur_head_)
200 extremes[d].slur_head_x_extent_
201 = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
210 Slur_score_state::fill (Grob *me)
212 slur_ = dynamic_cast<Spanner *> (me);
214 = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
216 if (columns_.empty ())
222 Slur::replace_breakable_encompass_objects (me);
223 staff_space_ = Staff_symbol_referencer::staff_space (me);
224 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
225 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
227 dir_ = slur_direction ();
228 parameters_.fill (me);
230 extract_grob_set (me, "note-columns", columns);
231 extract_grob_set (me, "encompass-objects", extra_objects);
233 Spanner *sp = dynamic_cast<Spanner *> (me);
235 for (int i = X_AXIS; i < NO_AXES; i++)
238 common_[a] = common_refpoint_of_array (columns, me, a);
239 common_[a] = common_refpoint_of_array (extra_objects, common_[a], a);
241 for (LEFT_and_RIGHT (d))
244 If bound is not in note-columns, we don't want to know about
248 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
252 extremes_ = get_bound_info ();
253 is_broken_ = (!extremes_[LEFT].note_column_
254 || !extremes_[RIGHT].note_column_);
257 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
258 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
260 base_attachments_ = get_base_attachments ();
262 Drul_array<Real> end_ys
263 = get_y_attachment_range ();
265 extra_encompass_infos_ = get_extra_encompass_infos ();
267 Interval additional_ys (0.0, 0.0);
269 for (vsize i = 0; i < extra_encompass_infos_.size (); i++)
271 if (extra_encompass_infos_[i].extents_[X_AXIS].is_empty ())
274 Real y_place = linear_interpolate (extra_encompass_infos_[i].extents_[X_AXIS].center (),
275 base_attachments_[RIGHT][X_AXIS],
276 base_attachments_[LEFT][X_AXIS],
279 Real encompass_place = extra_encompass_infos_[i].extents_[Y_AXIS][dir_];
280 if (extra_encompass_infos_[i].type_ == ly_symbol2scm ("inside")
281 && minmax (dir_, encompass_place, y_place) == encompass_place
282 && (!extra_encompass_infos_[i].grob_->internal_has_interface (ly_symbol2scm ("key-signature-interface"))
283 && !Clef::has_interface (extra_encompass_infos_[i].grob_)
284 && !Time_signature::has_interface (extra_encompass_infos_[i].grob_)))
286 for (LEFT_and_RIGHT (d))
287 additional_ys[d] = minmax (dir_,
290 * (parameters_.encompass_object_range_overshoot_
291 + (y_place - encompass_place)
292 * (normalize (extra_encompass_infos_[i].extents_[X_AXIS].center (),
293 base_attachments_[RIGHT][X_AXIS],
294 base_attachments_[LEFT][X_AXIS])
295 + (dir_ == LEFT ? 0 : -1)))));
299 for (LEFT_and_RIGHT (d))
300 end_ys[d] += additional_ys[d];
302 configurations_ = enumerate_attachments (end_ys);
303 for (vsize i = 0; i < columns_.size (); i++)
304 encompass_infos_.push_back (get_encompass_info (columns_[i]));
309 for (LEFT_and_RIGHT (d))
312 && extremes_[d].slur_head_)
314 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
318 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
319 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
325 MAKE_SCHEME_CALLBACK (Slur, calc_control_points, 1)
327 Slur::calc_control_points (SCM smob)
329 Spanner *me = unsmob_spanner (smob);
331 Slur_score_state state;
337 state.generate_curves ();
339 SCM end_ys = me->get_property ("positions");
340 SCM inspect_quants = me->get_property ("inspect-quants");
341 bool debug_slurs = to_boolean (me->layout ()
342 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")));
344 if (is_number_pair (inspect_quants))
347 end_ys = inspect_quants;
350 Slur_configuration *best = NULL;
351 if (is_number_pair (end_ys))
352 best = state.get_forced_configuration (ly_scm2interval (end_ys));
354 best = state.get_best_curve ();
356 #if DEBUG_SLUR_SCORING
359 string total = best->card ();
360 total += to_string (" TOTAL=%.2f idx=%d", best->score (), best->index_);
361 me->set_property ("annotation", ly_string2scm (total));
365 SCM controls = SCM_EOL;
366 for (int i = 4; i--;)
368 Offset o = best->curve_.control_[i]
369 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
370 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
371 controls = scm_cons (ly_offset2scm (o), controls);
378 Slur_score_state::get_forced_configuration (Interval ys) const
380 Slur_configuration *best = NULL;
382 for (vsize i = 0; i < configurations_.size (); i++)
384 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ys[LEFT])
385 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ys[RIGHT]);
388 best = configurations_[i];
393 while (!best->done ())
394 best->run_next_scorer (*this);
397 programming_error ("cannot find quant");
403 Slur_score_state::get_best_curve () const
405 std::priority_queue < Slur_configuration *, std::vector<Slur_configuration *>,
406 Slur_configuration_less > queue;
407 for (vsize i = 0; i < configurations_.size (); i++)
408 queue.push (configurations_[i]);
410 Slur_configuration *best = NULL;
418 best->run_next_scorer (*this);
426 Slur_score_state::breakable_bound_item (Direction d) const
428 Grob *col = slur_->get_bound (d)->get_column ();
430 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
432 for (vsize i = 0; i < extra_encompasses.size (); i++)
434 Item *item = dynamic_cast<Item *> (extra_encompasses[i]);
435 if (item && col == item->get_column ())
443 TODO: should analyse encompasses to determine sensible region, and
444 should limit slopes available.
448 Slur_score_state::get_y_attachment_range () const
450 Drul_array<Real> end_ys;
451 for (LEFT_and_RIGHT (d))
453 if (extremes_[d].note_column_)
456 * max (max (dir_ * (base_attachments_[d][Y_AXIS]
457 + parameters_.region_size_ * dir_),
458 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
459 dir_ * base_attachments_[-d][Y_AXIS]);
462 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
469 spanner_less (Spanner *s1, Spanner *s2)
472 for (LEFT_and_RIGHT (d))
474 b1[d] = s1->get_bound (d)->get_column ()->get_rank ();
475 b2[d] = s2->get_bound (d)->get_column ()->get_rank ();
478 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
479 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
483 Slur_score_state::get_base_attachments () const
485 Drul_array<Offset> base_attachment;
486 for (LEFT_and_RIGHT (d))
488 Grob *stem = extremes_[d].stem_;
489 Grob *head = extremes_[d].slur_head_;
493 if (extremes_[d].note_column_)
497 fixme: X coord should also be set in this case.
500 && !Stem::is_invisible (stem)
501 && extremes_[d].stem_dir_ == dir_
502 && Stem::get_beaming (stem, -d)
503 && Stem::get_beam (stem)
504 && (!spanner_less (slur_, Stem::get_beam (stem))
506 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
508 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
509 y += dir_ * 0.5 * staff_space_;
511 y = move_away_from_staffline (y, head);
513 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
515 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
516 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
517 .linear_combination (CENTER);
519 base_attachment[d] = Offset (x, y);
522 for (LEFT_and_RIGHT (d))
524 if (!extremes_[d].note_column_)
529 if (Grob *g = breakable_bound_item (d))
531 x = robust_relative_extent (g, common_[X_AXIS], X_AXIS)[RIGHT];
534 x = robust_relative_extent (extremes_[d].bound_, common_[X_AXIS], X_AXIS)[d];
536 x = slur_->get_broken_left_end_align ();
538 Grob *col = (d == LEFT) ? columns_[0] : columns_.back ();
540 if (extremes_[-d].bound_ != col)
542 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
543 y += dir_ * 0.5 * staff_space_;
545 if (get_grob_direction (col) == dir_
546 && Note_column::get_stem (col)
547 && !Stem::is_invisible (Note_column::get_stem (col)))
548 y -= dir_ * 1.5 * staff_space_;
551 y = base_attachment[-d][Y_AXIS];
553 y = move_away_from_staffline (y, col);
555 base_attachment[d] = Offset (x, y);
559 for (LEFT_and_RIGHT (d))
561 for (int a = X_AXIS; a < NO_AXES; a++)
563 Real &b = base_attachment[d][Axis (a)];
565 if (isinf (b) || isnan (b))
567 programming_error ("slur attachment is inf/nan");
573 return base_attachment;
577 Slur_score_state::move_away_from_staffline (Real y,
578 Grob *on_staff) const
583 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
588 = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
590 * 2.0 / staff_space_;
592 if (fabs (pos - my_round (pos)) < 0.2
593 && Staff_symbol_referencer::on_line (on_staff, (int) rint (pos))
594 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
595 y += 1.5 * staff_space_ * dir_ / 10;
601 Slur_score_state::generate_avoid_offsets () const
603 vector<Offset> avoid;
604 vector<Grob *> encompasses = columns_;
606 for (vsize i = 0; i < encompasses.size (); i++)
608 if (extremes_[LEFT].note_column_ == encompasses[i]
609 || extremes_[RIGHT].note_column_ == encompasses[i])
612 Encompass_info inf (get_encompass_info (encompasses[i]));
613 Real y = dir_ * (max (dir_ * inf.head_, dir_ * inf.stem_));
615 avoid.push_back (Offset (inf.x_, y + dir_ * parameters_.free_head_distance_));
618 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
619 for (vsize i = 0; i < extra_encompasses.size (); i++)
621 if (Slur::has_interface (extra_encompasses[i]))
623 Grob *small_slur = extra_encompasses[i];
624 Bezier b = Slur::get_curve (small_slur);
626 Offset z = b.curve_point (0.5);
627 z += Offset (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
628 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
630 z[Y_AXIS] += dir_ * parameters_.free_slur_distance_;
633 else if (extra_encompasses[i]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
635 Grob *g = extra_encompasses [i];
636 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
637 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
641 avoid.push_back (Offset (xe.center (), ye[dir_]));
648 Slur_score_state::generate_curves () const
650 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
651 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
653 vector<Offset> avoid = generate_avoid_offsets ();
654 for (vsize i = 0; i < configurations_.size (); i++)
655 configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
658 vector<Slur_configuration *>
659 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
661 vector<Slur_configuration *> scores;
663 Drul_array<Offset> os;
664 os[LEFT] = base_attachments_[LEFT];
665 Real minimum_length = staff_space_
666 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
668 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
670 os[RIGHT] = base_attachments_[RIGHT];
671 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
674 Drul_array<bool> attach_to_stem (false, false);
675 for (LEFT_and_RIGHT (d))
677 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
678 if (extremes_[d].stem_
679 && !Stem::is_invisible (extremes_[d].stem_)
680 && extremes_[d].stem_dir_ == dir_)
682 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
683 stem_y.widen (0.25 * staff_space_);
684 if (stem_y.contains (os[d][Y_AXIS]))
686 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
688 attach_to_stem[d] = true;
690 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
691 < dir_ * os[d][Y_AXIS]
692 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
694 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
699 dz = os[RIGHT] - os[LEFT];
700 if (dz[X_AXIS] < minimum_length
701 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
703 for (LEFT_and_RIGHT (d))
705 if (extremes_[d].slur_head_
706 && !extremes_[d].slur_head_x_extent_.is_empty ())
708 os[d][X_AXIS] = extremes_[d].slur_head_x_extent_.center ();
709 attach_to_stem[d] = false;
714 dz = os[RIGHT] - os[LEFT];
715 for (LEFT_and_RIGHT (d))
717 if (extremes_[d].slur_head_
718 && !attach_to_stem[d])
720 /* Horizontally move tilted slurs a little. Move
721 more for bigger tilts.
725 -= dir_ * extremes_[d].slur_head_x_extent_.length ()
726 * sin (dz.arg ()) / 3;
730 scores.push_back (Slur_configuration::new_config (os, scores.size ()));
732 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
735 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
738 assert (scores.size () > 0);
742 vector<Extra_collision_info>
743 Slur_score_state::get_extra_encompass_infos () const
745 extract_grob_set (slur_, "encompass-objects", encompasses);
746 vector<Extra_collision_info> collision_infos;
747 for (vsize i = encompasses.size (); i--;)
749 if (Slur::has_interface (encompasses[i]))
751 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
752 Bezier b = Slur::get_curve (small_slur);
754 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
755 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
757 for (int k = 0; k < 3; k++)
759 Direction hdir = Direction (k - 1);
762 Only take bound into account if small slur starts
763 together with big slur.
765 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
768 Offset z = b.curve_point (k / 2.0);
773 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
775 Interval xext (-1, 1);
776 xext = xext * (thickness_ * 2) + z[X_AXIS];
777 Extra_collision_info info (small_slur,
781 parameters_.extra_object_collision_penalty_);
782 collision_infos.push_back (info);
787 Grob *g = encompasses [i];
788 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
789 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
790 if (Dots::has_interface (g))
794 Real penalty = parameters_.extra_object_collision_penalty_;
795 if (Accidental_interface::has_interface (g))
797 penalty = parameters_.accidental_collision_;
799 Rational alt = ly_scm2rational (g->get_property ("alteration"));
800 SCM scm_style = g->get_property ("style");
801 if (!scm_is_symbol (scm_style)
802 && !to_boolean (g->get_property ("parenthesized"))
803 && !to_boolean (g->get_property ("restore-first")))
805 /* End copy accidental.cc */
806 if (alt == FLAT_ALTERATION
807 || alt == DOUBLE_FLAT_ALTERATION)
809 else if (alt == SHARP_ALTERATION)
811 else if (alt == NATURAL_ALTERATION)
816 ye.widen (thickness_ * 0.5);
817 xe.widen (thickness_ * 1.0);
818 Extra_collision_info info (g, xp, xe, ye, penalty);
819 collision_infos.push_back (info);
823 return collision_infos;
826 Extra_collision_info::Extra_collision_info (Grob *g, Real idx, Interval x, Interval y, Real p)
829 extents_[X_AXIS] = x;
830 extents_[Y_AXIS] = y;
833 type_ = g->get_property ("avoid-slur");
836 Extra_collision_info::Extra_collision_info ()