2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1996--2011 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"
29 #include "libc-extension.hh"
32 #include "note-column.hh"
33 #include "output-def.hh"
34 #include "paper-column.hh"
36 #include "pointer-group-interface.hh"
37 #include "slur-configuration.hh"
40 #include "staff-symbol-referencer.hh"
41 #include "staff-symbol.hh"
43 #include "time-signature.hh"
49 - curve around flag for y coordinate
51 - short-cut: try a smaller region first.
53 - handle non-visible stems better.
55 - try to prune number of scoring criteria
57 - take encompass-objects more into account when determining
60 - calculate encompass scoring directly after determining slur shape.
64 struct Slur_score_state;
66 Slur_score_state::Slur_score_state ()
70 edge_has_beams_ = false;
71 has_same_beam_ = false;
79 Slur_score_state::~Slur_score_state ()
81 junk_pointers (configurations_);
85 If a slur is broken across a line break, the direction
86 of the post-break slur must be the same as the pre-break
90 Slur_score_state::slur_direction () const
92 Grob *left_neighbor = slur_->broken_neighbor (LEFT);
94 if (left_neighbor && left_neighbor->is_live ())
95 return get_grob_direction (left_neighbor);
97 Direction dir = get_grob_direction (slur_);
99 if (Grob *right_neighbor = slur_->broken_neighbor (RIGHT))
100 set_grob_direction (right_neighbor, dir);
106 Slur_score_state::get_encompass_info (Grob *col) const
108 Grob *stem = unsmob_grob (col->get_object ("stem"));
113 programming_error ("no stem for note column");
114 ei.x_ = col->relative_coordinate (common_[X_AXIS], X_AXIS);
115 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS],
119 Direction stem_dir = get_grob_direction (stem);
121 if (Grob *head = Note_column::first_head (col))
122 ei.x_ = head->extent (common_[X_AXIS], X_AXIS).center ();
124 ei.x_ = col->extent (common_[X_AXIS], X_AXIS).center ();
126 Grob *h = Stem::extremal_heads (stem)[Direction (dir_)];
129 ei.head_ = ei.stem_ = col->extent (common_[Y_AXIS], Y_AXIS)[dir_];
133 ei.head_ = h->extent (common_[Y_AXIS], Y_AXIS)[dir_];
135 if ((stem_dir == dir_)
136 && !stem->extent (stem, Y_AXIS).is_empty ())
138 ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
139 if (Grob *b = Stem::get_beam (stem))
140 ei.stem_ += stem_dir * 0.5 * Beam::get_beam_thickness (b);
142 Interval x = stem->extent (common_[X_AXIS], X_AXIS);
143 ei.x_ = x.is_empty ()
144 ? stem->relative_coordinate (common_[X_AXIS], X_AXIS)
153 Drul_array<Bound_info>
154 Slur_score_state::get_bound_info () const
156 Drul_array<Bound_info> extremes;
159 Direction dir = dir_;
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);
205 while (flip (&d) != LEFT);
211 Slur_score_state::fill (Grob *me)
213 slur_ = dynamic_cast<Spanner *> (me);
215 = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
217 if (columns_.empty ())
223 Slur::replace_breakable_encompass_objects (me);
224 staff_space_ = Staff_symbol_referencer::staff_space (me);
225 Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
226 thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
228 dir_ = slur_direction ();
229 parameters_.fill (me);
231 extract_grob_set (me, "note-columns", columns);
232 extract_grob_set (me, "encompass-objects", extra_objects);
234 Spanner *sp = dynamic_cast<Spanner *> (me);
236 for (int i = X_AXIS; i < NO_AXES; i++)
239 common_[a] = common_refpoint_of_array (columns, me, a);
240 common_[a] = common_refpoint_of_array (extra_objects, common_[a], a);
246 If bound is not in note-columns, we don't want to know about
250 common_[a] = common_[a]->common_refpoint (sp->get_bound (d), a);
252 while (flip (&d) != LEFT);
255 extremes_ = get_bound_info ();
256 is_broken_ = (!extremes_[LEFT].note_column_
257 || !extremes_[RIGHT].note_column_);
260 = (extremes_[LEFT].stem_ && extremes_[RIGHT].stem_
261 && Stem::get_beam (extremes_[LEFT].stem_) == Stem::get_beam (extremes_[RIGHT].stem_));
263 base_attachments_ = get_base_attachments ();
265 Drul_array<Real> end_ys
266 = get_y_attachment_range ();
268 extra_encompass_infos_ = get_extra_encompass_infos ();
270 Interval additional_ys (0.0,0.0);
272 for (vsize i = 0; i < extra_encompass_infos_.size (); i++)
274 if (extra_encompass_infos_[i].extents_[X_AXIS].is_empty ())
277 Real y_place = linear_interpolate (extra_encompass_infos_[i].extents_[X_AXIS].center (),
278 base_attachments_[RIGHT][X_AXIS],
279 base_attachments_[LEFT][X_AXIS],
282 Real encompass_place = extra_encompass_infos_[i].extents_[Y_AXIS][dir_];
283 if (extra_encompass_infos_[i].type_ == ly_symbol2scm ("inside")
284 && minmax (dir_, encompass_place, y_place) == encompass_place
285 && (!extra_encompass_infos_[i].grob_->internal_has_interface (ly_symbol2scm ("key-signature-interface"))
286 && !Clef::has_interface (extra_encompass_infos_[i].grob_)
287 && !Time_signature::has_interface (extra_encompass_infos_[i].grob_)))
291 additional_ys[d] = minmax (dir_,
294 * (parameters_.encompass_object_range_overshoot_
295 + (y_place - encompass_place)
296 * (normalize (extra_encompass_infos_[i].extents_[X_AXIS].center (),
297 base_attachments_[RIGHT][X_AXIS],
298 base_attachments_[LEFT][X_AXIS])
299 + (dir_ == LEFT ? 0 : -1)))));
300 while (flip (&d) != LEFT);
306 end_ys[d] += additional_ys[d];
307 while (flip (&d) != LEFT);
309 configurations_ = enumerate_attachments (end_ys);
310 for (vsize i = 0; i < columns_.size (); i++)
311 encompass_infos_.push_back (get_encompass_info (columns_[i]));
319 && extremes_[d].slur_head_)
321 * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
323 while (flip (&d) != LEFT);
326 = (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
327 || (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
333 MAKE_SCHEME_CALLBACK (Slur, calc_control_points, 1)
335 Slur::calc_control_points (SCM smob)
337 Spanner *me = unsmob_spanner (smob);
339 Slur_score_state state;
345 state.generate_curves ();
347 SCM end_ys = me->get_property ("positions");
348 SCM inspect_quants = me->get_property ("inspect-quants");
349 bool debug_slurs = to_boolean (me->layout ()
350 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")));
352 if (is_number_pair (inspect_quants))
355 end_ys = inspect_quants;
358 Slur_configuration *best = NULL;
359 if (is_number_pair (end_ys))
360 best = state.get_forced_configuration (ly_scm2interval (end_ys));
362 best = state.get_best_curve ();
364 #if DEBUG_SLUR_SCORING
367 string total = best->card ();
368 total += to_string (" TOTAL=%.2f idx=%d", best->score (), best->index_);
369 me->set_property ("annotation", ly_string2scm (total));
373 SCM controls = SCM_EOL;
374 for (int i = 4; i--;)
376 Offset o = best->curve_.control_[i]
377 - Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
378 me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
379 controls = scm_cons (ly_offset2scm (o), controls);
386 Slur_score_state::get_forced_configuration (Interval ys) const
388 Slur_configuration *best = NULL;
390 for (vsize i = 0; i < configurations_.size (); i++)
392 Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ys[LEFT])
393 + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ys[RIGHT]);
396 best = configurations_[i];
401 while (!best->done ())
402 best->run_next_scorer (*this);
405 programming_error ("cannot find quant");
411 Slur_score_state::get_best_curve () const
413 std::priority_queue < Slur_configuration *, std::vector<Slur_configuration *>,
414 Slur_configuration_less > queue;
415 for (vsize i = 0; i < configurations_.size (); i++)
416 queue.push (configurations_[i]);
418 Slur_configuration *best = NULL;
426 best->run_next_scorer (*this);
434 Slur_score_state::breakable_bound_item (Direction d) const
436 Grob *col = slur_->get_bound (d)->get_column ();
438 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
440 for (vsize i = 0; i < extra_encompasses.size (); i++)
442 Item *item = dynamic_cast<Item *> (extra_encompasses[i]);
443 if (item && col == item->get_column ())
451 TODO: should analyse encompasses to determine sensible region, and
452 should limit slopes available.
456 Slur_score_state::get_y_attachment_range () const
458 Drul_array<Real> end_ys;
462 if (extremes_[d].note_column_)
465 * max (max (dir_ * (base_attachments_[d][Y_AXIS]
466 + parameters_.region_size_ * dir_),
467 dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
468 dir_ * base_attachments_[-d][Y_AXIS]);
471 end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
473 while (flip (&d) != LEFT);
479 spanner_less (Spanner *s1, Spanner *s2)
485 b1[d] = s1->get_bound (d)->get_column ()->get_rank ();
486 b2[d] = s2->get_bound (d)->get_column ()->get_rank ();
488 while (flip (&d) != LEFT);
490 return b2[LEFT] <= b1[LEFT] && b2[RIGHT] >= b1[RIGHT]
491 && (b2[LEFT] != b1[LEFT] || b2[RIGHT] != b1[RIGHT]);
495 Slur_score_state::get_base_attachments () const
497 Drul_array<Offset> base_attachment;
501 Grob *stem = extremes_[d].stem_;
502 Grob *head = extremes_[d].slur_head_;
506 if (extremes_[d].note_column_)
510 fixme: X coord should also be set in this case.
513 && !Stem::is_invisible (stem)
514 && extremes_[d].stem_dir_ == dir_
515 && Stem::get_beaming (stem, -d)
516 && Stem::get_beam (stem)
517 && (!spanner_less (slur_, Stem::get_beam (stem))
519 y = extremes_[d].stem_extent_[Y_AXIS][dir_];
521 y = head->extent (common_[Y_AXIS], Y_AXIS)[dir_];
522 y += dir_ * 0.5 * staff_space_;
524 y = move_away_from_staffline (y, head);
526 Grob *fh = Note_column::first_head (extremes_[d].note_column_);
528 = (fh ? fh->extent (common_[X_AXIS], X_AXIS)
529 : extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS))
530 .linear_combination (CENTER);
532 base_attachment[d] = Offset (x, y);
534 while (flip (&d) != LEFT);
538 if (!extremes_[d].note_column_)
543 if (Grob *g = breakable_bound_item (d))
545 x = robust_relative_extent (g, common_[X_AXIS], X_AXIS)[RIGHT];
548 x = robust_relative_extent (extremes_[d].bound_, common_[X_AXIS], X_AXIS)[d];
550 x = slur_->get_broken_left_end_align ();
552 Grob *col = (d == LEFT) ? columns_[0] : columns_.back ();
554 if (extremes_[-d].bound_ != col)
556 y = robust_relative_extent (col, common_[Y_AXIS], Y_AXIS)[dir_];
557 y += dir_ * 0.5 * staff_space_;
559 if (get_grob_direction (col) == dir_
560 && Note_column::get_stem (col)
561 && !Stem::is_invisible (Note_column::get_stem (col)))
562 y -= dir_ * 1.5 * staff_space_;
565 y = base_attachment[-d][Y_AXIS];
567 y = move_away_from_staffline (y, col);
569 base_attachment[d] = Offset (x, y);
572 while (flip (&d) != LEFT);
576 for (int a = X_AXIS; a < NO_AXES; a++)
578 Real &b = base_attachment[d][Axis (a)];
580 if (isinf (b) || isnan (b))
582 programming_error ("slur attachment is inf/nan");
587 while (flip (&d) != LEFT);
589 return base_attachment;
593 Slur_score_state::move_away_from_staffline (Real y,
594 Grob *on_staff) const
599 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
604 = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
606 * 2.0 / staff_space_;
608 if (fabs (pos - my_round (pos)) < 0.2
609 && Staff_symbol_referencer::on_line (on_staff, (int) rint (pos))
610 && Staff_symbol_referencer::line_count (on_staff) - 1 >= rint (pos))
611 y += 1.5 * staff_space_ * dir_ / 10;
617 Slur_score_state::generate_avoid_offsets () const
619 vector<Offset> avoid;
620 vector<Grob *> encompasses = columns_;
622 for (vsize i = 0; i < encompasses.size (); i++)
624 if (extremes_[LEFT].note_column_ == encompasses[i]
625 || extremes_[RIGHT].note_column_ == encompasses[i])
628 Encompass_info inf (get_encompass_info (encompasses[i]));
629 Real y = dir_ * (max (dir_ * inf.head_, dir_ * inf.stem_));
631 avoid.push_back (Offset (inf.x_, y + dir_ * parameters_.free_head_distance_));
634 extract_grob_set (slur_, "encompass-objects", extra_encompasses);
635 for (vsize i = 0; i < extra_encompasses.size (); i++)
637 if (Slur::has_interface (extra_encompasses[i]))
639 Grob *small_slur = extra_encompasses[i];
640 Bezier b = Slur::get_curve (small_slur);
642 Offset z = b.curve_point (0.5);
643 z += Offset (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
644 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
646 z[Y_AXIS] += dir_ * parameters_.free_slur_distance_;
649 else if (extra_encompasses[i]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
651 Grob *g = extra_encompasses [i];
652 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
653 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
657 avoid.push_back (Offset (xe.center (), ye[dir_]));
664 Slur_score_state::generate_curves () const
666 Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
667 Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
669 vector<Offset> avoid = generate_avoid_offsets ();
670 for (vsize i = 0; i < configurations_.size (); i++)
671 configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
674 vector<Slur_configuration *>
675 Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
677 vector<Slur_configuration *> scores;
679 Drul_array<Offset> os;
680 os[LEFT] = base_attachments_[LEFT];
681 Real minimum_length = staff_space_
682 * robust_scm2double (slur_->get_property ("minimum-length"), 2.0);
684 for (int i = 0; dir_ * os[LEFT][Y_AXIS] <= dir_ * end_ys[LEFT]; i++)
686 os[RIGHT] = base_attachments_[RIGHT];
687 for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
690 Drul_array<bool> attach_to_stem (false, false);
693 os[d][X_AXIS] = base_attachments_[d][X_AXIS];
694 if (extremes_[d].stem_
695 && !Stem::is_invisible (extremes_[d].stem_)
696 && extremes_[d].stem_dir_ == dir_)
698 Interval stem_y = extremes_[d].stem_extent_[Y_AXIS];
699 stem_y.widen (0.25 * staff_space_);
700 if (stem_y.contains (os[d][Y_AXIS]))
702 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS][-d]
704 attach_to_stem[d] = true;
706 else if (dir_ * extremes_[d].stem_extent_[Y_AXIS][dir_]
707 < dir_ * os[d][Y_AXIS]
708 && !extremes_[d].stem_extent_[X_AXIS].is_empty ())
710 os[d][X_AXIS] = extremes_[d].stem_extent_[X_AXIS].center ();
713 while (flip (&d) != LEFT);
716 dz = os[RIGHT] - os[LEFT];
717 if (dz[X_AXIS] < minimum_length
718 || fabs (dz[Y_AXIS] / dz[X_AXIS]) > parameters_.max_slope_)
722 if (extremes_[d].slur_head_
723 && !extremes_[d].slur_head_x_extent_.is_empty ())
725 os[d][X_AXIS] = extremes_[d].slur_head_x_extent_.center ();
726 attach_to_stem[d] = false;
729 while (flip (&d) != LEFT);
732 dz = os[RIGHT] - os[LEFT];
735 if (extremes_[d].slur_head_
736 && !attach_to_stem[d])
738 /* Horizontally move tilted slurs a little. Move
739 more for bigger tilts.
743 -= dir_ * extremes_[d].slur_head_x_extent_.length ()
744 * sin (dz.arg ()) / 3;
747 while (flip (&d) != LEFT);
749 scores.push_back (Slur_configuration::new_config (os, scores.size ()));
751 os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
754 os[LEFT][Y_AXIS] += dir_ * staff_space_ / 2;
757 assert (scores.size () > 0);
761 vector<Extra_collision_info>
762 Slur_score_state::get_extra_encompass_infos () const
764 extract_grob_set (slur_, "encompass-objects", encompasses);
765 vector<Extra_collision_info> collision_infos;
766 for (vsize i = encompasses.size (); i--;)
768 if (Slur::has_interface (encompasses[i]))
770 Spanner *small_slur = dynamic_cast<Spanner *> (encompasses[i]);
771 Bezier b = Slur::get_curve (small_slur);
773 Offset relative (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
774 small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
776 for (int k = 0; k < 3; k++)
778 Direction hdir = Direction (k - 1);
781 Only take bound into account if small slur starts
782 together with big slur.
784 if (hdir && small_slur->get_bound (hdir) != slur_->get_bound (hdir))
787 Offset z = b.curve_point (k / 2.0);
792 yext[dir_] = z[Y_AXIS] + dir_ * thickness_ * 1.0;
794 Interval xext (-1, 1);
795 xext = xext * (thickness_ * 2) + z[X_AXIS];
796 Extra_collision_info info (small_slur,
800 parameters_.extra_object_collision_penalty_);
801 collision_infos.push_back (info);
806 Grob *g = encompasses [i];
807 Interval xe = g->extent (common_[X_AXIS], X_AXIS);
808 Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
811 Real penalty = parameters_.extra_object_collision_penalty_;
812 if (Accidental_interface::has_interface (g))
814 penalty = parameters_.accidental_collision_;
816 Rational alt = ly_scm2rational (g->get_property ("alteration"));
817 SCM scm_style = g->get_property ("style");
818 if (!scm_is_symbol (scm_style)
819 && !to_boolean (g->get_property ("parenthesized"))
820 && !to_boolean (g->get_property ("restore-first")))
822 /* End copy accidental.cc */
823 if (alt == FLAT_ALTERATION
824 || alt == DOUBLE_FLAT_ALTERATION)
826 else if (alt == SHARP_ALTERATION)
828 else if (alt == NATURAL_ALTERATION)
833 ye.widen (thickness_ * 0.5);
834 xe.widen (thickness_ * 1.0);
835 Extra_collision_info info (g, xp, xe, ye, penalty);
836 collision_infos.push_back (info);
840 return collision_infos;
843 Extra_collision_info::Extra_collision_info (Grob *g, Real idx, Interval x, Interval y, Real p)
846 extents_[X_AXIS] = x;
847 extents_[Y_AXIS] = y;
850 type_ = g->get_property ("avoid-slur");
853 Extra_collision_info::Extra_collision_info ()