/*
- slur-scoring.cc -- Score based slur formatting
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
Jan Nieuwenhuizen <janneke@gnu.org>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "slur-scoring.hh"
-#include "libc-extension.hh"
-#include "slur-configuration.hh"
+
+#include <queue>
+
+#include "accidental-interface.hh"
#include "beam.hh"
#include "directional-element-interface.hh"
-#include "pointer-group-interface.hh"
-#include "slur.hh"
+#include "libc-extension.hh"
+#include "main.hh"
#include "note-column.hh"
#include "output-def.hh"
+#include "paper-column.hh"
#include "pitch.hh"
+#include "pointer-group-interface.hh"
+#include "slur-configuration.hh"
+#include "slur.hh"
#include "spanner.hh"
#include "staff-symbol-referencer.hh"
#include "staff-symbol.hh"
#include "stem.hh"
#include "warn.hh"
-#include "paper-column.hh"
-#include "accidental-interface.hh"
/*
TODO:
junk_pointers (configurations_);
}
-Real
-get_detail (SCM alist, SCM sym)
-{
- SCM entry = scm_assq (sym, alist);
- return robust_scm2double (scm_is_pair (entry)
- ? scm_cdr (entry)
- : SCM_EOL,
- 0.0);
-}
-
-void
-Slur_score_parameters::fill (Grob *me)
-{
- SCM details = me->get_property ("details");
-
- region_size_
- = (int) get_detail (details, ly_symbol2scm ("region-size"));
- head_encompass_penalty_
- = get_detail (details, ly_symbol2scm ("head-encompass-penalty"));
- stem_encompass_penalty_
- = get_detail (details, ly_symbol2scm ("stem-encompass-penalty"));
- closeness_factor_
- = get_detail (details, ly_symbol2scm ("closeness-factor"));
- edge_attraction_factor_
- = get_detail (details, ly_symbol2scm ("edge-attraction-factor"));
- same_slope_penalty_
- = get_detail (details, ly_symbol2scm ("same-slope-penalty"));
- steeper_slope_factor_
- = get_detail (details, ly_symbol2scm ("steeper-slope-factor"));
- non_horizontal_penalty_
- = get_detail (details, ly_symbol2scm ("non-horizontal-penalty"));
- max_slope_
- = get_detail (details, ly_symbol2scm ("max-slope"));
- max_slope_factor_
- = get_detail (details, ly_symbol2scm ("max-slope-factor"));
- free_head_distance_
- = get_detail (details, ly_symbol2scm ("free-head-distance"));
- absolute_closeness_measure_
- = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
- extra_object_collision_penalty_
- = get_detail (details, ly_symbol2scm ("extra-object-collision-penalty"));
- accidental_collision_
- = get_detail (details, ly_symbol2scm ("accidental-collision"));
- extra_encompass_free_distance_
- = get_detail (details, ly_symbol2scm ("extra-encompass-free-distance"));
- head_slur_distance_factor_
- = get_detail (details, ly_symbol2scm ("head-slur-distance-factor"));
- head_slur_distance_max_ratio_
- = get_detail (details, ly_symbol2scm ("head-slur-distance-max-ratio"));
- free_slur_distance_
- = get_detail (details, ly_symbol2scm ("free-slur-distance"));
- edge_slope_exponent_
- = get_detail (details, ly_symbol2scm ("edge-slope-exponent"));
-}
-
-Real
-broken_trend_y (Slur_score_state const &state, Direction hdir)
-{
- /* A broken slur should maintain the same vertical trend
- the unbroken slur would have had. */
- Real by = 0.0;
- if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original ()))
- {
- vsize k = broken_spanner_index (state.slur_);
- int j = k + hdir;
- if (j < 0 || j >= mother->broken_intos_.size ())
- return by;
-
- Grob *neighbor = mother->broken_intos_[j];
- Spanner *common_mother
- = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original ());
- int common_k
- = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
- int common_j = common_k + hdir;
-
- if (common_j < 0 || common_j >= common_mother->broken_intos_.size ())
- return by;
-
- Grob *common_next_system = common_mother->broken_intos_[common_j];
-
- SCM last_point = scm_car (scm_last_pair (neighbor->get_property ("control-points")));
-
- return scm_to_double (scm_cdr (last_point))
- + neighbor->relative_coordinate (common_next_system, Y_AXIS);
- }
- return by;
-}
-
/*
- copy slur dir forwards across line break.
+ If a slur is broken across a line break, the direction
+ of the post-break slur must be the same as the pre-break
+ slur.
*/
-void
-Slur_score_state::set_next_direction ()
+Direction
+Slur_score_state::slur_direction () const
{
- if (extremes_[RIGHT].note_column_)
- return;
+ Grob *left_neighbor = slur_->broken_neighbor (LEFT);
- if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original ()))
- {
- vsize k = broken_spanner_index (slur_);
- int j = k + 1;
- if (j < 0 || j >= mother->broken_intos_.size ())
- return;
+ if (left_neighbor && left_neighbor->is_live ())
+ return get_grob_direction (left_neighbor);
- Grob *neighbor = mother->broken_intos_[j];
- set_grob_direction (neighbor, dir_);
- }
+ Direction dir = get_grob_direction (slur_);
+
+ if (Grob *right_neighbor = slur_->broken_neighbor (RIGHT))
+ set_grob_direction (right_neighbor, dir);
+
+ return dir;
}
Encompass_info
{
ei.stem_ = stem->extent (common_[Y_AXIS], Y_AXIS)[dir_];
if (Grob *b = Stem::get_beam (stem))
- ei.stem_ += stem_dir * 0.5 * Beam::get_thickness (b);
+ ei.stem_ += stem_dir * 0.5 * Beam::get_beam_thickness (b);
Interval x = stem->extent (common_[X_AXIS], X_AXIS);
ei.x_ = x.is_empty ()
slur_ = dynamic_cast<Spanner *> (me);
columns_
= internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
-
+
if (columns_.empty ())
{
me->suicide ();
return;
}
+ Slur::replace_breakable_encompass_objects (me);
staff_space_ = Staff_symbol_referencer::staff_space (me);
Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
- dir_ = get_grob_direction (me);
+ dir_ = slur_direction ();
parameters_.fill (me);
extract_grob_set (me, "note-columns", columns);
= (extremes_[LEFT].stem_ && Stem::get_beam (extremes_[LEFT].stem_))
|| (extremes_[RIGHT].stem_ && Stem::get_beam (extremes_[RIGHT].stem_));
- set_next_direction ();
-
if (is_broken_)
musical_dy_ = 0.0;
}
-MAKE_SCHEME_CALLBACK(Slur, calc_control_points, 1)
+MAKE_SCHEME_CALLBACK (Slur, calc_control_points, 1)
SCM
Slur::calc_control_points (SCM smob)
{
state.generate_curves ();
SCM end_ys = me->get_property ("positions");
- Bezier best;
-
+ SCM inspect_quants = me->get_property ("inspect-quants");
+ if (is_number_pair (inspect_quants))
+ end_ys = inspect_quants;
+
+ Slur_configuration *best = NULL;
if (is_number_pair (end_ys))
- best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
+ best = state.get_forced_configuration (ly_scm2interval(end_ys));
else
best = state.get_best_curve ();
+#if DEBUG_SLUR_SCORING
+ bool debug_slurs = to_boolean (me->layout ()
+ ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")));
+ if (debug_slurs)
+ {
+ string total = best->card ();
+ total += to_string (" TOTAL=%.2f idx=%d", best->score (), best->index_);
+ me->set_property ("quant-score", ly_string2scm (total));
+ }
+#endif
+
SCM controls = SCM_EOL;
for (int i = 4; i--;)
{
- Offset o = best.control_[i]
+ Offset o = best->curve_.control_[i]
- Offset (me->relative_coordinate (state.common_[X_AXIS], X_AXIS),
me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
controls = scm_cons (ly_offset2scm (o), controls);
return controls;
}
-Bezier
-Slur_score_state::get_best_curve ()
+Slur_configuration*
+Slur_score_state::get_forced_configuration (Interval ys) const
{
- int opt_idx = -1;
- Real opt = 1e6;
-
-#if DEBUG_SLUR_SCORING
- SCM inspect_quants = slur_->get_property ("inspect-quants");
- if (to_boolean (slur_->layout ()
- ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
- && scm_is_pair (inspect_quants))
- {
- opt_idx = get_closest_index (inspect_quants);
- configurations_[opt_idx]->score (*this);
- opt = configurations_[opt_idx]->score_;
- }
- else
-#endif
+ Slur_configuration *best = NULL;
+ Real mindist = 1e6;
+ for (vsize i = 0; i < configurations_.size (); i++)
{
- for (vsize i = 0; i < configurations_.size (); i++)
- configurations_[i]->score (*this);
- for (vsize i = 0; i < configurations_.size (); i++)
+ Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ys[LEFT])
+ + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ys[RIGHT]);
+ if (d < mindist)
{
- if (configurations_[i]->score_ < opt)
- {
- opt = configurations_[i]->score_;
- opt_idx = i;
- }
+ best = configurations_[i];
+ mindist = d;
}
}
-#if DEBUG_SLUR_SCORING
- if (opt_idx >= 0)
- {
- configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
- configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
- }
- else
- {
- programming_error ("No optimal slur found. Guessing 0.");
- opt_idx = 0;
- }
+ while (!best->done ())
+ best->run_next_scorer (*this);
- // debug quanting
- slur_->set_property ("quant-score",
- scm_makfrom0str (configurations_[opt_idx]->score_card_.c_str ()));
+ if (mindist > 1e5)
+ programming_error ("cannot find quant");
+
+ return best;
+}
-#endif
- return configurations_[opt_idx]->curve_;
+Slur_configuration *
+Slur_score_state::get_best_curve () const
+{
+ std::priority_queue<Slur_configuration*, std::vector<Slur_configuration*>,
+ Slur_configuration_less> queue;
+ for (vsize i = 0; i < configurations_.size (); i++)
+ queue.push (configurations_[i]);
+
+ Slur_configuration *best = NULL;
+ while (true) {
+ best = queue.top ();
+ if (best->done ())
+ break;
+
+ queue.pop ();
+ best->run_next_scorer (*this);
+ queue.push (best);
+ }
+
+ return best;
}
-int
-Slur_score_state::get_closest_index (SCM inspect_quants) const
+Grob *
+Slur_score_state::breakable_bound_item (Direction d) const
{
- Drul_array<Real> ins = ly_scm2interval (inspect_quants);
+ Grob *col = slur_->get_bound (d)->get_column ();
- int opt_idx = -1;
- Real mindist = 1e6;
- for (vsize i = 0; i < configurations_.size (); i++)
+ extract_grob_set (slur_, "encompass-objects", extra_encompasses);
+
+ for (vsize i = 0; i < extra_encompasses.size (); i++)
{
- Real d = fabs (configurations_[i]->attachment_[LEFT][Y_AXIS] - ins[LEFT])
- + fabs (configurations_[i]->attachment_[RIGHT][Y_AXIS] - ins[RIGHT]);
- if (d < mindist)
- {
- opt_idx = i;
- mindist = d;
- }
+ Item *item = dynamic_cast<Item*> (extra_encompasses[i]);
+ if (item && col == item->get_column ())
+ return item;
}
- if (mindist > 1e5)
- programming_error ("can't not find quant");
- return opt_idx;
+
+ return 0;
}
/*
{
end_ys[d] = dir_
* max (max (dir_ * (base_attachments_[d][Y_AXIS]
- + parameters_.region_size_ * dir_),
+ + parameters_.region_size_ * dir_),
dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
dir_ * base_attachments_[-d][Y_AXIS]);
}
{
if (!extremes_[d].note_column_)
{
- Real x, y;
- if (d == RIGHT)
- x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
+ Real x = 0;
+ Real y = 0;
+
+ if (Grob *g = breakable_bound_item (d))
+ {
+ x = robust_relative_extent (g, common_[X_AXIS], X_AXIS)[RIGHT];
+ }
+ else if (d == RIGHT)
+ x = robust_relative_extent (extremes_[d].bound_, common_[X_AXIS], X_AXIS)[d];
else
x = slur_->get_broken_left_end_align ();
+
Grob *col = (d == LEFT) ? columns_[0] : columns_.back ();
if (extremes_[-d].bound_ != col)
if (!xe.is_empty ()
&& !ye.is_empty ())
- avoid.push_back (Offset (xe.center(), ye[dir_]));
+ avoid.push_back (Offset (xe.center (), ye[dir_]));
}
}
return avoid;
os[RIGHT] = base_attachments_[RIGHT];
for (int j = 0; dir_ * os[RIGHT][Y_AXIS] <= dir_ * end_ys[RIGHT]; j++)
{
- Slur_configuration s;
Direction d = LEFT;
Drul_array<bool> attach_to_stem (false, false);
do
}
while (flip (&d) != LEFT);
- s.attachment_ = os;
- s.index_ = scores.size ();
-
- scores.push_back (new Slur_configuration (s));
+ scores.push_back (Slur_configuration::new_config (os, scores.size ()));
os[RIGHT][Y_AXIS] += dir_ * staff_space_ / 2;
}
for (int k = 0; k < 3; k++)
{
- Direction hdir = Direction (k / 2 - 1);
+ Direction hdir = Direction (k - 1);
/*
Only take bound into account if small slur starts
Interval xext (-1, 1);
xext = xext * (thickness_ * 2) + z[X_AXIS];
Extra_collision_info info (small_slur,
- k - 1.0,
+ hdir,
xext,
yext,
parameters_.extra_object_collision_penalty_);
if (Accidental_interface::has_interface (g))
{
penalty = parameters_.accidental_collision_;
- /* Begin copy accidental.cc */
- bool parens = false;
- if (to_boolean (g->get_property ("cautionary")))
- {
- SCM cstyle = g->get_property ("cautionary-style");
- parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
- }
- SCM accs = g->get_property ("accidentals");
+ Rational alt = ly_scm2rational (g->get_property ("alteration"));
SCM scm_style = g->get_property ("style");
if (!scm_is_symbol (scm_style)
- && !parens
- && scm_ilength (accs) == 1)
+ && !to_boolean (g->get_property ("parenthesized"))
+ && !to_boolean (g->get_property ("restore-first")))
{
/* End copy accidental.cc */
- switch (scm_to_int (scm_car (accs)))
- {
- case FLAT:
- case DOUBLE_FLAT:
- xp = LEFT;
- break;
- case SHARP:
- xp = 0.5 * dir_;
- break;
- case NATURAL:
- xp = -dir_;
- break;
- }
+ if (alt == FLAT_ALTERATION
+ || alt == DOUBLE_FLAT_ALTERATION)
+ xp = LEFT;
+ else if (alt == SHARP_ALTERATION)
+ xp = 0.5 * dir_;
+ else if (alt == NATURAL_ALTERATION)
+ xp = -dir_;
}
}