/*
- slur-configuration.cc -- implement Slur_configuration
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ 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-configuration.hh"
-#include <math.h>
-
-#include "stem.hh"
-#include "warn.hh"
-#include "misc.hh"
#include "item.hh"
-#include "group-interface.hh"
-#include "slur.hh"
+#include "libc-extension.hh"
+#include "misc.hh"
+#include "pointer-group-interface.hh"
#include "slur-scoring.hh"
+#include "slur.hh"
#include "spanner.hh"
#include "staff-symbol-referencer.hh"
-#include "libc-extension.hh"
+#include "stem.hh"
+#include "warn.hh"
Bezier
avoid_staff_line (Slur_score_state const &state,
- Bezier bez)
+ Bezier bez)
{
Offset horiz (1, 0);
- Array<Real> ts = bez.solve_derivative (horiz);
+ vector<Real> ts = bez.solve_derivative (horiz);
/* TODO: handle case of broken slur. */
- if (!ts.is_empty ()
+ if (!ts.empty ()
&& (state.extremes_[LEFT].staff_ == state.extremes_[RIGHT].staff_)
&& state.extremes_[LEFT].staff_ && state.extremes_[RIGHT].staff_)
{
Grob *staff = state.extremes_[LEFT].staff_;
Real p = 2 * (y - staff->relative_coordinate (state.common_[Y_AXIS], Y_AXIS))
- / state.staff_space_;
+ / state.staff_space_;
- Real distance = fabs (my_round (p) - p); // in halfspaces
+ Real distance = fabs (my_round (p) - p); // in halfspaces
if (distance < 4 * state.thickness_
- && (int) fabs (my_round (p))
- <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
- && (int (fabs (my_round (p))) % 2
- != Staff_symbol_referencer::line_count (staff) % 2))
- {
- Direction resolution_dir
- = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
-
- // TODO: parameter
- Real newp = my_round (p) + resolution_dir
- * 5 * state.thickness_;
-
- Real dy = (newp - p) * state.staff_space_ / 2.0;
-
- bez.control_[1][Y_AXIS] += dy;
- bez.control_[2][Y_AXIS] += dy;
- }
+ && (int) fabs (my_round (p))
+ <= 2 * Staff_symbol_referencer::staff_radius (staff) + 0.1
+ && (int (fabs (my_round (p))) % 2
+ != Staff_symbol_referencer::line_count (staff) % 2))
+ {
+ Direction resolution_dir
+ = (distance ? state.dir_ : Direction (sign (p - my_round (p))));
+
+ // TODO: parameter
+ Real newp = my_round (p) + resolution_dir
+ * 5 * state.thickness_;
+
+ Real dy = (newp - p) * state.staff_space_ / 2.0;
+
+ bez.control_[1][Y_AXIS] += dy;
+ bez.control_[2][Y_AXIS] += dy;
+ }
}
return bez;
}
Real
-fit_factor (Offset dz_unit, Offset dz_perp,
- Bezier curve, Direction d, Array<Offset> const &avoid)
+fit_factor (Offset dz_unit, Offset dz_perp, Real close_to_edge_length,
+ Bezier curve, Direction d, vector<Offset> const &avoid)
{
Real fit_factor = 0.0;
Offset x0 = curve.control_[0];
curve_xext.add_point (curve.control_[0][X_AXIS]);
curve_xext.add_point (curve.control_[3][X_AXIS]);
- for (int i = 0; i < avoid.size (); i++)
+ for (vsize i = 0; i < avoid.size (); i++)
{
Offset z = (avoid[i] - x0);
Offset p (dot_product (z, dz_unit),
- d * dot_product (z, dz_perp));
- if (!curve_xext.contains (p[X_AXIS]))
- continue;
+ d * dot_product (z, dz_perp));
+
+ bool close_to_edge = false;
+ Direction d = LEFT;
+ do
+ close_to_edge = close_to_edge || -d * (p[X_AXIS] - curve_xext[d]) < close_to_edge_length;
+ while (flip (&d) != LEFT);
+
+ if (close_to_edge)
+ continue;
+
+ Real eps = 0.01;
+ Interval pext = eps * Interval (-1, 1) + p[X_AXIS];
+ pext.intersect (curve_xext);
+
+ if (pext.is_empty () || pext.length () <= 1.999 * eps)
+ continue;
Real y = curve.get_other_coordinate (X_AXIS, p[X_AXIS]);
if (y)
- {
- fit_factor = max (fit_factor, (p[Y_AXIS] / y));
- }
+ fit_factor = max (fit_factor, (p[Y_AXIS] / y));
}
return fit_factor;
}
void
Slur_configuration::generate_curve (Slur_score_state const &state,
- Real r_0, Real h_inf,
- Array<Offset> const &avoid
- )
+ Real r_0, Real h_inf,
+ vector<Offset> const &avoid)
{
- Offset dz = attachment_[RIGHT]- attachment_[LEFT];;
+ Offset dz = attachment_[RIGHT] - attachment_[LEFT];;
Offset dz_unit = dz;
dz_unit *= 1 / dz.length ();
Offset dz_perp = dz_unit * Offset (0, 1);
max_h = len / 3.0;
}
else
- {
- max_h = sqrt (max_h);
- }
+ max_h = sqrt (max_h);
Real eccentricity = robust_scm2double (state.slur_->get_property ("eccentricity"), 0);
Bezier curve;
curve.control_[0] = attachment_[LEFT];
curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
- + dz_unit * x1;
+ + dz_unit * x1;
curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
- + dz_unit * x2;
+ + dz_unit * x2;
curve.control_[3] = attachment_[RIGHT];
- Real ff = fit_factor (dz_unit, dz_perp, curve, state.dir_, avoid);
+ Real ff = fit_factor (dz_unit, dz_perp, state.parameters_.close_to_edge_length_,
+ curve, state.dir_, avoid);
height = max (height, min (height * ff, max_h));
curve.control_[0] = attachment_[LEFT];
curve.control_[1] = attachment_[LEFT] + dz_perp * height * state.dir_
- + dz_unit * x1;
+ + dz_unit * x1;
curve.control_[2] = attachment_[RIGHT] + dz_perp * height * state.dir_
- + dz_unit * x2;
+ + dz_unit * x2;
curve.control_[3] = attachment_[RIGHT];
curve_ = avoid_staff_line (state, curve);
index_ = -1;
};
+void
+Slur_configuration::add_score (Real s, string desc)
+{
+ if (s < 0)
+ {
+ programming_error ("Negative demerits found for slur. Ignoring");
+ s = 0.0;
+ }
+
+ if (s)
+ {
+ if (score_card_.length () > 0)
+ score_card_ += ", ";
+ score_card_ += to_string ("%s=%.2f", desc.c_str (), s);
+ score_ += s;
+ }
+}
+
void
Slur_configuration::score_encompass (Slur_score_state const &state)
{
Distances for heads that are between slur and line between
attachment points.
*/
- Array<Real> convex_head_distances;
- for (int j = 0; j < state.encompass_infos_.size (); j++)
+ vector<Real> convex_head_distances;
+ for (vsize j = 0; j < state.encompass_infos_.size (); j++)
{
Real x = state.encompass_infos_[j].x_;
bool edge = l_edge || r_edge;
if (! (x < attachment_[RIGHT][X_AXIS]
- && x > attachment_[LEFT][X_AXIS]))
- continue;
+ && x > attachment_[LEFT][X_AXIS]))
+ continue;
Real y = bez.get_other_coordinate (X_AXIS, x);
if (!edge)
- {
- Real head_dy = (y - state.encompass_infos_[j].head_);
- if (state.dir_ * head_dy < 0)
- {
- demerit += state.parameters_.head_encompass_penalty_;
- convex_head_distances.push (0.0);
- }
- else
- {
- Real hd = (head_dy)
- ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
- : state.parameters_.head_encompass_penalty_;
- hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
-
- demerit += hd;
- }
-
- Real line_y = linear_interpolate (x,
- attachment_[RIGHT][X_AXIS],
- attachment_[LEFT][X_AXIS],
- attachment_[RIGHT][Y_AXIS],
- attachment_[LEFT][Y_AXIS]);
-
- if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
- {
-
- Real closest
- = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
- Real d = fabs (closest - y);
-
- convex_head_distances.push (d);
- }
- }
+ {
+ Real head_dy = (y - state.encompass_infos_[j].head_);
+ if (state.dir_ * head_dy < 0)
+ {
+ demerit += state.parameters_.head_encompass_penalty_;
+ convex_head_distances.push_back (0.0);
+ }
+ else
+ {
+ Real hd = (head_dy)
+ ? (1 / fabs (head_dy) - 1 / state.parameters_.free_head_distance_)
+ : state.parameters_.head_encompass_penalty_;
+ hd = min (max (hd, 0.0), state.parameters_.head_encompass_penalty_);
+
+ demerit += hd;
+ }
+
+ Real line_y = linear_interpolate (x,
+ attachment_[RIGHT][X_AXIS],
+ attachment_[LEFT][X_AXIS],
+ attachment_[RIGHT][Y_AXIS],
+ attachment_[LEFT][Y_AXIS]);
+
+ if (1) // state.dir_ * state.encompass_infos_[j].get_point (state.dir_) > state.dir_ *line_y )
+ {
+
+ Real closest
+ = state.dir_ * max (state.dir_ * state.encompass_infos_[j].get_point (state.dir_), state.dir_ * line_y);
+ Real d = fabs (closest - y);
+
+ convex_head_distances.push_back (d);
+ }
+ }
if (state.dir_ * (y - state.encompass_infos_[j].stem_) < 0)
- {
- Real stem_dem = state.parameters_.stem_encompass_penalty_;
- if ((l_edge && state.dir_ == UP)
- || (r_edge && state.dir_ == DOWN))
- stem_dem /= 5;
-
- demerit += stem_dem;
- }
- else if (!edge)
- {
- Interval ext;
- ext.add_point (state.encompass_infos_[j].stem_);
- ext.add_point (state.encompass_infos_[j].head_);
-
- // ?
- demerit += -state.parameters_.closeness_factor_
- * min (state.dir_
- * (y - (ext[state.dir_] + state.dir_ * state.parameters_.free_head_distance_)), 0.0)
- / state.encompass_infos_.size ();
- }
+ {
+ Real stem_dem = state.parameters_.stem_encompass_penalty_;
+ if ((l_edge && state.dir_ == UP)
+ || (r_edge && state.dir_ == DOWN))
+ stem_dem /= 5;
+
+ demerit += stem_dem;
+ }
}
-
- Real variance_penalty = 0.0;
+ add_score (demerit, "encompass");
if (convex_head_distances.size ())
{
Real avg_distance = 0.0;
Real min_dist = infinity_f;
- for (int j = 0; j < convex_head_distances.size (); j++)
- {
- min_dist = min (min_dist, convex_head_distances[j]);
- avg_distance += convex_head_distances[j];
- }
+ for (vsize j = 0; j < convex_head_distances.size (); j++)
+ {
+ min_dist = min (min_dist, convex_head_distances[j]);
+ avg_distance += convex_head_distances[j];
+ }
/*
- For slurs over 3 or 4 heads, the average distance is not a
- good normalizer.
+ For slurs over 3 or 4 heads, the average distance is not a
+ good normalizer.
*/
Real n = convex_head_distances.size ();
if (n <= 2)
- {
- Real fact = 1.0;
- avg_distance += height_ * fact;
- n += fact;
- }
+ {
+ Real fact = 1.0;
+ avg_distance += height_ * fact;
+ n += fact;
+ }
/*
- TODO: maybe it's better to use (avgdist - mindist)*factor
- as penalty.
+ TODO: maybe it's better to use (avgdist - mindist)*factor
+ as penalty.
*/
avg_distance /= n;
- variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
+ Real variance_penalty = state.parameters_.head_slur_distance_max_ratio_;
if (min_dist > 0.0)
- variance_penalty
- = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
+ variance_penalty
+ = min ((avg_distance / (min_dist + state.parameters_.absolute_closeness_measure_) - 1.0), variance_penalty);
variance_penalty = max (variance_penalty, 0.0);
variance_penalty *= state.parameters_.head_slur_distance_factor_;
- }
-
-#if DEBUG_SLUR_SCORING
- score_card_ += to_string ("C%.2f", demerit);
- score_card_ += to_string ("D%.2f", variance_penalty);
-#endif
- score_ += demerit + variance_penalty;
+ add_score (variance_penalty, "variance");
+ }
}
void
Slur_configuration::score_extra_encompass (Slur_score_state const &state)
{
- Real demerit = 0.0;
- for (int j = 0; j < state.extra_encompass_infos_.size (); j++)
+ for (vsize j = 0; j < state.extra_encompass_infos_.size (); j++)
{
Drul_array<Offset> attachment = attachment_;
+ Extra_collision_info const &info (state.extra_encompass_infos_[j]);
+
Interval slur_wid (attachment[LEFT][X_AXIS], attachment[RIGHT][X_AXIS]);
/*
- to prevent numerical inaccuracies in
- Bezier::get_other_coordinate ().
+ to prevent numerical inaccuracies in
+ Bezier::get_other_coordinate ().
*/
Direction d = LEFT;
bool found = false;
Real y = 0.0;
do
- {
- /*
- We need to check for the bound explicitly, since the
- slur-ending can be almost vertical, making the Y
- coordinate a bad approximation of the object-slur
- distance.
- */
- Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
- if ((as_item
- && as_item->get_column ()
- == state.extremes_[d].bound_->get_column ())
- || state.extra_encompass_infos_[j].extents_[X_AXIS].contains (attachment[d][X_AXIS]))
- {
- y = attachment[d][Y_AXIS];
- found = true;
- }
- }
+ {
+ /*
+ We need to check for the bound explicitly, since the
+ slur-ending can be almost vertical, making the Y
+ coordinate a bad approximation of the object-slur
+ distance.
+ */
+ Item *as_item = dynamic_cast<Item *> (state.extra_encompass_infos_[j].grob_);
+ if (!as_item)
+ continue;
+
+ Interval item_x = as_item->extent (state.common_[X_AXIS], X_AXIS);
+ item_x.intersect (state.extremes_[d].slur_head_x_extent_);
+ if (!item_x.is_empty ())
+ {
+ y = attachment[d][Y_AXIS];
+ found = true;
+ }
+
+ }
while (flip (&d) != LEFT);
if (!found)
- {
- Real x = state.extra_encompass_infos_[j].extents_[X_AXIS]
- .linear_combination (state.extra_encompass_infos_[j].idx_);
+ {
+ Real x = info.extents_[X_AXIS].linear_combination (info.idx_);
+
+ if (!slur_wid.contains (x))
+ continue;
+
+ y = curve_.get_other_coordinate (X_AXIS, x);
+ }
+
+ Real dist = 0.0;
+ if (info.type_ == ly_symbol2scm ("around"))
+ dist = info.extents_[Y_AXIS].distance (y);
- if (!slur_wid.contains (x))
- continue;
+ /*
+ Have to score too: the curve enumeration is limited in its
+ shape, and may produce curves which collide anyway.
+ */
+ else if (info.type_ == ly_symbol2scm ("inside"))
+ dist = state.dir_ * (y - info.extents_[Y_AXIS][state.dir_]);
+ else
+ programming_error ("unknown avoidance type");
+
+ dist = max (dist, 0.0);
- y = curve_.get_other_coordinate (X_AXIS, x);
- }
+ Real penalty = info.penalty_ * peak_around (0.1 * state.parameters_.extra_encompass_free_distance_,
+ state.parameters_.extra_encompass_free_distance_,
+ dist);
- Real dist = state.extra_encompass_infos_[j].extents_[Y_AXIS].distance (y);
- demerit
- += fabs (max (0.0, (state.parameters_.extra_encompass_free_distance_ - dist)))
- / state.parameters_.extra_encompass_free_distance_
- * state.extra_encompass_infos_[j].penalty_;
+ add_score (penalty, "extra");
}
-#if DEBUG_SLUR_SCORING
- score_card_ += to_string ("X%.2f", demerit);
-#endif
- score_ += demerit;
}
void
{
Direction d = LEFT;
Offset dz = attachment_[RIGHT]
- - attachment_[LEFT];
+ - attachment_[LEFT];
Real slope = dz[Y_AXIS] / dz[X_AXIS];
do
{
Real factor = state.parameters_.edge_attraction_factor_;
Real demerit = factor * dy;
if (state.extremes_[d].stem_
- && state.extremes_[d].stem_dir_ == state.dir_
- && !Stem::get_beaming (state.extremes_[d].stem_, -d))
- demerit /= 5;
+ && state.extremes_[d].stem_dir_ == state.dir_
+ // TODO - Stem::get_beaming() should be precomputed.
+ && !Stem::get_beaming (state.extremes_[d].stem_, -d))
+ demerit /= 5;
demerit *= exp (state.dir_ * d * slope
- * state.parameters_.edge_slope_exponent_);
+ * state.parameters_.edge_slope_exponent_);
- score_ += demerit;
-#if DEBUG_SLUR_SCORING
- score_card_ += to_string ("E%.2f", demerit);
-#endif
+ string dir_str = d == LEFT ? "L" : "R";
+ add_score (demerit, dir_str + " edge");
}
while (flip (&d) != LEFT);
}
void
-Slur_configuration ::score_slopes (Slur_score_state const &state)
+Slur_configuration::score_slopes (Slur_score_state const &state)
{
Real dy = state.musical_dy_;
Offset slur_dz = attachment_[RIGHT] - attachment_[LEFT];
Real demerit = 0.0;
demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
- - state.parameters_.max_slope_), 0.0)
- * state.parameters_.max_slope_factor_;
+ - state.parameters_.max_slope_), 0.0)
+ * state.parameters_.max_slope_factor_;
/* 0.2: account for staffline offset. */
Real max_dy = (fabs (dy) + 0.2);
if (!state.is_broken_)
demerit += state.parameters_.steeper_slope_factor_
- * (max (fabs (slur_dy) -max_dy, 0.0));
+ * (max (fabs (slur_dy) - max_dy, 0.0));
demerit += max ((fabs (slur_dy / slur_dz[X_AXIS])
- - state.parameters_.max_slope_), 0.0)
- * state.parameters_.max_slope_factor_;
+ - state.parameters_.max_slope_), 0.0)
+ * state.parameters_.max_slope_factor_;
if (sign (dy) == 0
&& sign (slur_dy) != 0
&& sign (slur_dy)
&& sign (slur_dy) != sign (dy))
demerit += state.edge_has_beams_
- ? state.parameters_.same_slope_penalty_ / 10
- : state.parameters_.same_slope_penalty_;
+ ? state.parameters_.same_slope_penalty_ / 10
+ : state.parameters_.same_slope_penalty_;
-#if DEBUG_SLUR_SCORING
- score_card_ += to_string ("S%.2f", demerit);
-#endif
- score_ += demerit;
+ add_score (demerit, "slope");
+}
+
+// This is a temporary hack to see how much we can gain by using a
+// priority queue on the beams to score.
+static int score_count = 0;
+LY_DEFINE (ly_slur_score_count, "ly:slur-score-count", 0, 0, 0,
+ (),
+ "count number of slur scores.")
+{
+ return scm_from_int (score_count);
}
void
-Slur_configuration::score (Slur_score_state const &state)
+Slur_configuration::run_next_scorer (Slur_score_state const &state)
+{
+ switch (next_scorer_todo)
+ {
+ case EXTRA_ENCOMPASS:
+ score_extra_encompass (state);
+ break;
+ case SLOPE:
+ score_slopes (state);
+ break;
+ case EDGES:
+ score_edges (state);
+ break;
+ case ENCOMPASS:
+ score_encompass (state);
+ break;
+ default:
+ assert (false);
+ }
+ next_scorer_todo++;
+ score_count++;
+}
+
+bool
+Slur_configuration::done () const
+{
+ return next_scorer_todo >= NUM_SCORERS;
+}
+
+Slur_configuration *
+Slur_configuration::new_config (Drul_array<Offset> const &offs, int idx)
{
- score_extra_encompass (state);
- score_slopes (state);
- score_edges (state);
- score_encompass (state);
+ Slur_configuration *conf = new Slur_configuration;
+ conf->attachment_ = offs;
+ conf->index_ = idx;
+ conf->next_scorer_todo = INITIAL_SCORE + 1;
+ return conf;
}