/*
beam.cc -- implement Beam
-
+
source file of the GNU LilyPond music typesetter
-
- (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- Jan Nieuwenhuizen <janneke@gnu.org>
-
+
+ (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
+
*/
/*
[TODO]
- * different left/right quanting: slope, multiplicity
-
* Fix TODO
* Junk stem_info.
It may only set directions for stems.
* Rewrite stem_beams.
-
+
+ * Use Number_pair i.s.o Interval to represent (yl, yr).
+
+
*/
#include "spanner.hh"
#include "warn.hh"
+
+#define DEBUG_QUANTING 0
+
+
+#if DEBUG_QUANTING
+#include "text-item.hh" // debug output.
+#include "font-interface.hh" // debug output.
+#endif
+
+
+const int INTER_QUANT_PENALTY = 1000;
+const int SECONDARY_BEAM_DEMERIT = 15;
+const int STEM_LENGTH_DEMERIT_FACTOR = 5;
+// possibly ridiculous, but too short stems just won't do
+const int STEM_LENGTH_LIMIT_PENALTY = 5000;
+const int DAMPING_DIRECTIION_PENALTY = 800;
+const int MUSICAL_DIRECTION_FACTOR = 400;
+const int IDEAL_SLOPE_FACTOR = 10;
+const int REGION_SIZE = 2;
+
+
+static Real
+shrink_extra_weight (Real x)
+{
+ return fabs (x) * ((x < 0) ? 1.5 : 1.0);
+}
+
void
Beam::add_stem (Grob *me, Grob *s)
{
add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (s));
}
+Real
+Beam::get_interbeam (Grob *me)
+{
+ SCM func = me->get_grob_property ("space-function");
+ SCM s = gh_call2 (func, me->self_scm (), gh_int2scm (get_multiplicity (me)));
+ return gh_scm2double (s);
+}
+
+/*
+ Maximum multiplicity.
+ */
int
Beam::get_multiplicity (Grob *me)
{
return m;
}
+MAKE_SCHEME_CALLBACK (Beam, space_function, 2);
+SCM
+Beam::space_function (SCM smob, SCM multiplicity)
+{
+ Grob *me = unsmob_grob (smob);
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ Real line = me->paper_l ()->get_var ("linethickness");
+ Real thickness = gh_scm2double (me->get_grob_property ("thickness"))
+ * staff_space;
+
+ Real interbeam = gh_scm2int (multiplicity) < 4
+ ? (2*staff_space + line - thickness) / 2.0
+ : (3*staff_space + line - thickness) / 3.0;
+
+ return gh_double2scm (interbeam);
+}
+
+
/* After pre-processing all directions should be set.
Several post-processing routines (stem, slur, script) need stem/beam
direction.
}
if (count >= 1)
{
- if (!Directional_element_interface::get (me))
- Directional_element_interface::set (me, get_default_dir (me));
-
- consider_auto_knees (me);
- set_stem_directions (me);
+ Direction d = get_default_dir (me);
+
+ consider_auto_knees (me, d);
+ set_stem_directions (me, d);
set_stem_shorten (me);
}
+
return SCM_EOL;
}
do {
Grob *s = stems[i];
Direction sd = Directional_element_interface::get (s);
- int current = sd ? (1 + d * sd)/2
- : Stem::get_center_distance (s, (Direction)-d);
+
+ int center_distance = int(- d * Stem::head_positions (s) [-d]) >? 0;
+ int current = sd ? (1 + d * sd)/2 : center_distance;
if (current)
{
total[d] += current;
count[d] ++;
}
-
} while (flip (&d) != DOWN);
SCM func = me->get_grob_property ("dir-function");
Urg: non-forced should become `without/with unforced' direction,
once stem gets cleaned-up. */
void
-Beam::set_stem_directions (Grob *me)
+Beam::set_stem_directions (Grob *me, Direction d)
{
Link_array<Item> stems
=Pointer_group_interface__extract_grobs (me, (Item*) 0, "stems");
- Direction d = Directional_element_interface::get (me);
for (int i=0; i <stems.size (); i++)
{
`Forced' stem directions are ignored. If you don't want auto-knees,
don't set, or unset auto-knee-gap. */
void
-Beam::consider_auto_knees (Grob *me)
+Beam::consider_auto_knees (Grob *me, Direction d)
{
SCM scm = me->get_grob_property ("auto-knee-gap");
Real staff_space = Staff_symbol_referencer::staff_space (me);
Real gap = gh_scm2double (scm) / staff_space;
- Direction d = Directional_element_interface::get (me);
+
Link_array<Item> stems=
Pointer_group_interface__extract_grobs (me, (Item*)0, "stems");
}
/* Set stem's shorten property if unset.
- TODO:
+
+ TODO:
take some y-position (chord/beam/nearest?) into account
- scmify forced-fraction */
+ scmify forced-fraction
+
+ TODO:
+
+ why is shorten stored in beam, and not directly in stem?
+
+*/
void
Beam::set_stem_shorten (Grob *m)
{
/* your similar cute comment here */
shorten_f *= forced_fraction;
-
- me->set_grob_property ("shorten", gh_double2scm (shorten_f));
+
+ if (shorten_f)
+ me->set_grob_property ("shorten", gh_double2scm (shorten_f));
}
/* Call list of y-dy-callbacks, that handle setting of
- grob-properties y, dy.
-
- User may set grob-properties: y-position-hs and height-hs
- (to be fixed) that override the calculated y and dy.
-
- Because y and dy cannot be calculated and quanted separately, we
- always calculate both, then check for user override. */
+ grob-properties
+
+*/
MAKE_SCHEME_CALLBACK (Beam, after_line_breaking, 1);
SCM
Beam::after_line_breaking (SCM smob)
if (ly_car (s) != SCM_BOOL_F)
return SCM_UNSPECIFIED;
+ // one wonders if such genericity is necessary --hwn.
SCM callbacks = me->get_grob_property ("position-callbacks");
for (SCM i = callbacks; gh_pair_p (i); i = ly_cdr (i))
gh_call1 (ly_car (i), smob);
+ set_stem_lengths (me);
+ return SCM_UNSPECIFIED;
+}
+
+struct Quant_score
+{
+ Real yl;
+ Real yr;
+ Real demerits;
+};
+
+
+/*
+ TODO:
+
+ - Make all demerits customisable
+
+ - One sensible check per demerit (what's this --hwn)
+
+ - Add demerits for quants per se, as to forbid a specific quant
+ entirely
+
+*/
+MAKE_SCHEME_CALLBACK (Beam, quanting, 1);
+SCM
+Beam::quanting (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ SCM s = me->get_grob_property ("positions");
+ Real yl = gh_scm2double (gh_car (s));
+ Real yr = gh_scm2double (gh_cdr (s));
+
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ Real thickness = gh_scm2double (me->get_grob_property ("thickness")) / ss;
+ Real slt = me->paper_l ()->get_var ("linethickness") / ss;
+
+
+ SCM sdy = me->get_grob_property ("least-squares-dy");
+ Real dy_mus = gh_number_p (sdy) ? gh_scm2double (sdy) : 0.0;
+
+ Real straddle = 0.0;
+ Real sit = (thickness - slt) / 2;
+ Real inter = 0.5;
+ Real hang = 1.0 - (thickness - slt) / 2;
+ Real quants [] = {straddle, sit, inter, hang };
+
+ int num_quants = int (sizeof (quants)/sizeof (Real));
+ Array<Real> quantsl;
+ Array<Real> quantsr;
+
+ /*
+ going to REGION_SIZE == 2, yields another 0.6 second with
+ wtk1-fugue2.
+
+
+ (result indexes between 70 and 575) ? --hwn.
+
+ */
+
+
+
+ /*
+ Do stem computations. These depend on YL and YR linearly, so we can
+ precompute for every stem 2 factors.
+ */
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+ Array<Stem_info> stem_infos;
+ Array<Real> lbase_lengths;
+ Array<Real> rbase_lengths;
+
+ Drul_array<bool> dirs_found(0,0);
+ for (int i= 0; i < stems.size(); i++)
+ {
+ Grob*s = stems[i];
+ stem_infos.push (Stem::calc_stem_info (s));
+ dirs_found[stem_infos.top ().dir_] = true;
+
+ Real b = calc_stem_y (me, s, Interval (1,0), false);
+ lbase_lengths.push (b);
+
+ Real a = calc_stem_y (me, s, Interval (0,1), false);
+ rbase_lengths.push (a);
+ }
+
+ Direction ldir = Direction (stem_infos[0].dir_);
+ Direction rdir = Direction (stem_infos.top ().dir_);
+ bool knee_b = dirs_found[LEFT] && dirs_found[RIGHT];
+
+
+ int region_size = REGION_SIZE;
+ /*
+ Knees are harder, lets try some more possibilities for knees.
+ */
+ if (knee_b)
+ region_size += 2;
+
+ for (int i = -region_size ; i < region_size; i++)
+ for (int j = 0; j < num_quants; j++)
+ {
+ quantsl.push (i + quants[j] + int (yl));
+ quantsr.push (i + quants[j] + int (yr));
+ }
+
+ Array<Quant_score> qscores;
+
+ for (int l =0; l < quantsl.size (); l++)
+ for (int r =0; r < quantsr.size (); r++)
+ {
+ Quant_score qs;
+ qs.yl = quantsl[l];
+ qs.yr = quantsr[r];
+ qs.demerits = 0.0;
+
+ qscores.push (qs);
+ }
+
+
+ /*
+ This is a longish function, but we don't separate this out into
+ neat modular separate subfunctions, as the subfunctions would be
+ called for many values of YL, YR. By precomputing various
+ parameters outside of the loop, we can save a lot of time.
+
+ */
+ for (int i = qscores.size (); i--;)
+ if (qscores[i].demerits < 100)
+ {
+ qscores[i].demerits
+ += score_slopes_dy (me, qscores[i].yl, qscores[i].yr,
+ dy_mus, yr- yl);
+ }
+
+ Real rad = Staff_symbol_referencer::staff_radius (me);
+ int multiplicity = get_multiplicity (me);
+ Real interbeam = multiplicity < 4
+ ? (2*ss + slt - thickness) / 2.0
+ : (3*ss + slt - thickness) / 3.0;
+
+ for (int i = qscores.size (); i--;)
+ if (qscores[i].demerits < 100)
+ {
+ qscores[i].demerits
+ += score_forbidden_quants (me, qscores[i].yl, qscores[i].yr,
+ rad, slt, thickness, interbeam,
+ multiplicity, ldir, rdir);
+ }
+
+
+ for (int i = qscores.size (); i--;)
+ if (qscores[i].demerits < 100)
+ {
+ qscores[i].demerits
+ += score_stem_lengths (stems, stem_infos,
+ lbase_lengths, rbase_lengths,
+ knee_b,
+ me, qscores[i].yl, qscores[i].yr);
+ }
+
+
+ Real best = 1e6;
+ int best_idx = -1;
+ for (int i = qscores.size (); i--;)
+ {
+ if (qscores[i].demerits < best)
+ {
+ best = qscores [i].demerits ;
+ best_idx = i;
+ }
+ }
+
+
+ me->set_grob_property ("positions",
+ gh_cons (gh_double2scm (qscores[best_idx].yl),
+ gh_double2scm (qscores[best_idx].yr))
+ );
+
+#if DEBUG_QUANTING
+
+ // debug quanting
+ me->set_grob_property ("quant-score",
+ gh_double2scm (qscores[best_idx].demerits));
+ me->set_grob_property ("best-idx", gh_int2scm (best_idx));
+#endif
+
return SCM_UNSPECIFIED;
}
+Real
+Beam::score_stem_lengths (Link_array<Grob>stems,
+ Array<Stem_info> stem_infos,
+ Array<Real> left_factor,
+ Array<Real> right_factor,
+ bool knee,
+ Grob*me,
+ Real yl, Real yr)
+{
+ Real demerit_score = 0.0 ;
+ Real pen = STEM_LENGTH_LIMIT_PENALTY;
+
+ for (int i=0; i < stems.size (); i++)
+ {
+ Grob* s = stems[i];
+ if (Stem::invisible_b (s))
+ continue;
+
+ Real current_y =
+ yl * left_factor[i] + right_factor[i]* yr;
+
+ Stem_info info = stem_infos[i];
+ Direction d = info.dir_;
+
+ demerit_score += pen
+ * ( 0 >? (info.dir_ * (info.shortest_y_ - current_y)));
+
+ demerit_score += STEM_LENGTH_DEMERIT_FACTOR
+ * shrink_extra_weight (d * current_y - info.dir_ * info.ideal_y_);
+ }
+
+ demerit_score *= 2.0 / stems.size ();
+
+ return demerit_score;
+}
+
+Real
+Beam::score_slopes_dy (Grob *me,
+ Real yl, Real yr,
+ Real dy_mus, Real dy_damp)
+{
+ Real dy = yr - yl;
+
+ Real dem = 0.0;
+ if (sign (dy_damp) != sign (dy))
+ {
+ dem += DAMPING_DIRECTIION_PENALTY;
+ }
+
+ dem += MUSICAL_DIRECTION_FACTOR * (0 >? (fabs (dy) - fabs (dy_mus)));
+ dem += shrink_extra_weight (fabs (dy_damp) - fabs (dy))* IDEAL_SLOPE_FACTOR;
+
+ return dem;
+}
+
+static Real
+my_modf (Real x)
+{
+ return x - floor (x);
+}
+
+Real
+Beam::score_forbidden_quants (Grob*me,
+ Real yl, Real yr,
+ Real rad,
+ Real slt,
+ Real thickness, Real interbeam,
+ int multiplicity,
+ Direction ldir, Direction rdir)
+{
+ Real dy = yr - yl;
+
+ Real dem = 0.0;
+ if (fabs (yl) < rad && fabs ( my_modf (yl) - 0.5) < 1e-3)
+ dem += INTER_QUANT_PENALTY;
+ if (fabs (yr) < rad && fabs ( my_modf (yr) - 0.5) < 1e-3)
+ dem += INTER_QUANT_PENALTY;
+
+ // todo: use multiplicity of outer stems.
+ if (multiplicity >= 2)
+ {
+
+ Real straddle = 0.0;
+ Real sit = (thickness - slt) / 2;
+ Real inter = 0.5;
+ Real hang = 1.0 - (thickness - slt) / 2;
+
+
+ if (fabs (yl - ldir * interbeam) < rad
+ && fabs (my_modf (yl) - inter) < 1e-3)
+ dem += SECONDARY_BEAM_DEMERIT;
+ if (fabs (yr - rdir * interbeam) < rad
+ && fabs (my_modf (yr) - inter) < 1e-3)
+ dem += SECONDARY_BEAM_DEMERIT;
+
+ Real eps = 1e-3;
+
+ /*
+ Can't we simply compute the distance between the nearest
+ staffline and the secondary beam? That would get rid of the
+ silly case analysis here (which is probably not when we have
+ different beam-thicknesses.)
+
+ --hwn
+ */
+
+
+ // hmm, without Interval/Drul_array, you get ~ 4x same code...
+ if (fabs (yl - ldir * interbeam) < rad + inter)
+ {
+ if (ldir == UP && dy <= eps
+ && fabs (my_modf (yl) - sit) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+
+ if (ldir == DOWN && dy >= eps
+ && fabs (my_modf (yl) - hang) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+ }
+
+ if (fabs (yr - rdir * interbeam) < rad + inter)
+ {
+ if (rdir == UP && dy >= eps
+ && fabs (my_modf (yr) - sit) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+
+ if (rdir == DOWN && dy <= eps
+ && fabs (my_modf (yr) - hang) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+ }
+
+ if (multiplicity >= 3)
+ {
+ if (fabs (yl - 2 * ldir * interbeam) < rad + inter)
+ {
+ if (ldir == UP && dy <= eps
+ && fabs (my_modf (yl) - straddle) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+
+ if (ldir == DOWN && dy >= eps
+ && fabs (my_modf (yl) - straddle) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+ }
+
+ if (fabs (yr - 2 * rdir * interbeam) < rad + inter)
+ {
+ if (rdir == UP && dy >= eps
+ && fabs (my_modf (yr) - straddle) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+
+ if (rdir == DOWN && dy <= eps
+ && fabs (my_modf (yr) - straddle) < eps)
+ dem += SECONDARY_BEAM_DEMERIT;
+ }
+ }
+ }
+
+ return dem;
+}
+
+
MAKE_SCHEME_CALLBACK (Beam, least_squares, 1);
SCM
me->set_grob_property ("positions", ly_interval2scm (pos));
return SCM_UNSPECIFIED;
}
-
- Direction dir = Directional_element_interface::get (me);
- Interval ideal (Stem::calc_stem_info (first_visible_stem (me)).idealy_f_,
- Stem::calc_stem_info (last_visible_stem (me)).idealy_f_);
+ Interval ideal (Stem::calc_stem_info (first_visible_stem (me)).ideal_y_,
+ Stem::calc_stem_info (last_visible_stem (me)).ideal_y_);
+
+
+
+ Array<Real> x_posns ;
+ Link_array<Item> stems=
+ Pointer_group_interface__extract_grobs (me, (Item*)0, "stems");
+ Grob *common = stems[0];
+ for (int i=1; i < stems.size (); i++)
+ common = stems[i]->common_refpoint (common, X_AXIS);
+
+ Real x0 = first_visible_stem (me)->relative_coordinate (common, X_AXIS);
+ for (int i=0; i < stems.size (); i++)
+ {
+ Item* s = stems[i];
+
+ Real x = s->relative_coordinate (common, X_AXIS) - x0;
+ x_posns.push (x);
+ }
+ Real dx = last_visible_stem (me)->relative_coordinate (common, X_AXIS) - x0;
+
+ Real y =0;
+ Real dydx = 0;
+ Real dy = 0;
+
if (!ideal.delta ())
{
- Interval chord (Stem::chord_start_f (first_visible_stem (me)),
- Stem::chord_start_f (last_visible_stem (me)));
-
+ Interval chord (Stem::chord_start_y (first_visible_stem (me)),
+ Stem::chord_start_y (last_visible_stem (me)));
+
+
+ /*
+ TODO -- use scoring for this.
+
+ complicated, because we take stem-info.ideal for determining
+ beam slopes.
+ */
/* Make simple beam on middle line have small tilt */
if (!ideal[LEFT] && chord.delta () && count == 2)
{
- Direction d = (Direction)(sign (chord.delta ()) * dir);
- pos[d] = gh_scm2double (me->get_grob_property ("thickness")) / 2
- * dir;
+
+ /*
+ FIXME. -> UP
+ */
+ Direction d = (Direction) (sign (chord.delta ()) * UP);
+ pos[d] = gh_scm2double (me->get_grob_property ("thickness")) / 2;
+ // * dir;
pos[-d] = - pos[d];
}
else
- pos = ideal;
+ {
+ pos = ideal;
+ }
+
+ y = pos[LEFT];
+ dy = pos[RIGHT]- y;
+ dydx = dy/dx;
}
else
{
Array<Offset> ideals;
-
- // ugh -> use commonx
- Real x0 = first_visible_stem (me)->relative_coordinate (0, X_AXIS);
- Link_array<Item> stems=
- Pointer_group_interface__extract_grobs (me, (Item*)0, "stems");
-
for (int i=0; i < stems.size (); i++)
{
Item* s = stems[i];
if (Stem::invisible_b (s))
continue;
- ideals.push (Offset (s->relative_coordinate (0, X_AXIS) - x0,
- Stem::calc_stem_info (s).idealy_f_));
+ ideals.push (Offset (x_posns[i],
+ Stem::calc_stem_info (s).ideal_y_));
}
- Real y;
- Real dydx;
minimise_least_squares (&dydx, &y, ideals);
- Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - x0;
- Real dy = dydx * dx;
- me->set_grob_property ("least-squares-dy", gh_double2scm (dy * dir));
+ dy = dydx * dx;
+ me->set_grob_property ("least-squares-dy", gh_double2scm (dy));
+ pos = Interval (y, (y+dy));
+ }
+
+ me->set_grob_property ("positions", ly_interval2scm (pos));
+
+ return SCM_UNSPECIFIED;
+}
+
+
+/*
+ We can't combine with previous function, since check concave and
+ slope damping comes first.
+ */
+MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 1);
+SCM
+Beam::shift_region_to_valid (SCM grob)
+{
+ Grob *me = unsmob_grob (grob);
+ /*
+ Code dup.
+ */
+ Array<Real> x_posns ;
+ Link_array<Item> stems=
+ Pointer_group_interface__extract_grobs (me, (Item*)0, "stems");
+ Grob *common = stems[0];
+ for (int i=1; i < stems.size (); i++)
+ common = stems[i]->common_refpoint (common, X_AXIS);
+
+ Grob *fvs = first_visible_stem (me);
+
+ if (!fvs)
+ return SCM_UNSPECIFIED;
+
+ Real x0 =fvs->relative_coordinate (common, X_AXIS);
+ for (int i=0; i < stems.size (); i++)
+ {
+ Item* s = stems[i];
- pos = Interval (y*dir, (y+dy) * dir);
+ Real x = s->relative_coordinate (common, X_AXIS) - x0;
+ x_posns.push (x);
}
+ Grob *lvs = last_visible_stem (me);
+ if (!lvs)
+ return SCM_UNSPECIFIED;
+
+ Real dx = lvs->relative_coordinate (common, X_AXIS) - x0;
+
+ Interval pos = ly_scm2interval ( me->get_grob_property ("positions"));
+ Real dy = pos.delta();
+ Real y = pos[LEFT];
+ Real dydx =dy/dx;
+
+
+ /*
+ Shift the positions so that we have a chance of finding good
+ quants (i.e. no short stem failures.)
+ */
+ Interval feasible_left_point;
+ feasible_left_point.set_full ();
+ for (int i=0; i < stems.size (); i++)
+ {
+ Item* s = stems[i];
+ if (Stem::invisible_b (s))
+ continue;
+
+
+ Direction d = Stem::get_direction (s);
+
+
+ Real left_y = Stem::calc_stem_info (s).shortest_y_
+ - dydx * x_posns [i];
+
+ Interval flp ;
+ flp.set_full ();
+ flp[-d] = left_y;
+
+ feasible_left_point.intersect (flp);
+ }
+
+ if (feasible_left_point.empty_b())
+ {
+ warning (_("Not sure that we can find a nice beam slope (no viable initial configuration found)."));
+ }
+ else if (!feasible_left_point.elem_b(y))
+ {
+ if (isinf (feasible_left_point[DOWN]))
+ y = feasible_left_point[UP] - REGION_SIZE;
+ else if (isinf (feasible_left_point[UP]))
+ y = feasible_left_point[DOWN]+ REGION_SIZE;
+ else
+ y = feasible_left_point.center ();
+ }
+ pos = Interval (y, (y+dy));
me->set_grob_property ("positions", ly_interval2scm (pos));
return SCM_UNSPECIFIED;
}
+
MAKE_SCHEME_CALLBACK (Beam, check_concave, 1);
SCM
Beam::check_concave (SCM smob)
if (stems.size () < 3)
return SCM_UNSPECIFIED;
- /* Concaveness try #2: Sum distances of inner noteheads that
- fall outside the interval of the two outer noteheads */
- Real concave = 0;
- Interval iv (Stem::chord_start_f (stems[0]),
- Stem::chord_start_f (stems.top ()));
-
- if (iv[MAX] < iv[MIN])
- iv.swap ();
-
- for (int i = 1; i < stems.size () - 1; i++)
+
+ /* Concaveness #1: If distance of an inner notehead to line between
+ two outer noteheads is bigger than CONCAVENESS-GAP (2.0ss),
+ beam is concave (Heinz Stolba).
+
+ In the case of knees, the line connecting outer heads is often
+ not related to the beam slope (it may even go in the other
+ direction). Skip the check when the outer stems point in
+ different directions. --hwn
+
+ */
+ bool concaveness1 = false;
+ SCM gap = me->get_grob_property ("concaveness-gap");
+ if (gh_number_p (gap)
+ && Stem::get_direction(stems.top ())
+ == Stem::get_direction(stems[0]))
{
- Real c = 0;
- Real f = Stem::chord_start_f (stems[i]);
- if ((c = f - iv[MAX]) > 0)
- concave += c;
- else if ((c = f - iv[MIN]) < 0)
- concave += c;
- }
- concave *= Directional_element_interface::get (me);
+ Real r1 = gh_scm2double (gap);
+ Real dy = Stem::chord_start_y (stems.top ())
+ - Stem::chord_start_y (stems[0]);
+
- Real concaveness = concave / (stems.size () - 2);
- /* ugh: this is the a kludge to get input/regression/beam-concave.ly
- to behave as baerenreiter. */
- concaveness /= (stems.size () - 2);
+ Real slope = dy / (stems.size () - 1);
+
+ Real y0 = Stem::chord_start_y (stems[0]);
+ for (int i = 1; i < stems.size () - 1; i++)
+ {
+ Real c = (Stem::chord_start_y (stems[i]) - y0) - i * slope;
+ if (c > r1)
+ {
+ concaveness1 = true;
+ break;
+ }
+ }
+ }
+
+
+ /* Concaveness #2: Sum distances of inner noteheads that fall
+ outside the interval of the two outer noteheads.
+
+ We only do this for beams where first and last stem have the same
+ direction. --hwn.
+
+
+ Note that "convex" stems compensate for "concave" stems.
+ (is that intentional?) --hwn.
+ */
- Real r = gh_scm2double (me->get_grob_property ("concaveness-threshold"));
+ Real concaveness2 = 0;
+ SCM thresh = me->get_grob_property ("concaveness-threshold");
+ Real r2 = infinity_f;
+ if (!concaveness1 && gh_number_p (thresh)
+ && Stem::get_direction(stems.top ())
+ == Stem::get_direction(stems[0]))
+ {
+ r2 = gh_scm2double (thresh);
+ Direction dir = Stem::get_direction(stems.top ());
+ Real concave = 0;
+ Interval iv (Stem::chord_start_y (stems[0]),
+ Stem::chord_start_y (stems.top ()));
+
+ if (iv[MAX] < iv[MIN])
+ iv.swap ();
+
+ for (int i = 1; i < stems.size () - 1; i++)
+ {
+ Real f = Stem::chord_start_y (stems[i]);
+ concave += ((f - iv[MAX] ) >? 0) +
+ ((f - iv[MIN] ) <? 0);
+ }
+ concave *= dir;
+ concaveness2 = concave / (stems.size () - 2);
+
+ /* ugh: this is the a kludge to get
+ input/regression/beam-concave.ly to behave as
+ baerenreiter. */
+
+ /*
+ huh? we're dividing twice (which is not scalable) meaning that
+ the longer the beam, the more unlikely it will be
+ concave. Maybe you would even expect the other way around??
+
+ --hwn.
+
+ */
+ concaveness2 /= (stems.size () - 2);
+ }
+
/* TODO: some sort of damping iso -> plain horizontal */
- if (concaveness > r)
+ if (concaveness1 || concaveness2 > r2)
{
Interval pos = ly_scm2interval (me->get_grob_property ("positions"));
Real r = pos.linear_combination (0);
me->set_grob_property ("positions", ly_interval2scm (Interval (r, r)));
- me->remove_grob_property ("least-squares-dy");
+ me->set_grob_property ("least-squares-dy", gh_double2scm (0));
}
return SCM_UNSPECIFIED;
me->set_grob_property ("positions", ly_interval2scm (pos));
}
- return SCM_UNSPECIFIED;
-}
-
-
-/* Prevent interference from stafflines. */
-Interval
-Beam::quantise_interval (Grob *me, Interval pos, Direction quant_dir)
-{
- int multiplicity = get_multiplicity (me);
-
- Real staff_space = Staff_symbol_referencer::staff_space (me);
- Real thick = me->paper_l ()->get_var ("stafflinethickness");
- Direction dir = Directional_element_interface::get (me);
- Real dy = pos.delta ();
-
- Drul_array<Interval> bounds;
- Direction d = LEFT;
- do
- {
- SCM proc = d == LEFT
- ? me->get_grob_property ("left-position-quant-function")
- : me->get_grob_property ("right-position-quant-function");
-
- SCM quants = scm_apply (proc,
- me->self_scm (),
- scm_list_n (gh_int2scm (multiplicity),
- gh_double2scm (dir),
- gh_double2scm (dy),
- gh_double2scm (thick / staff_space),
- /* HUH? */
- SCM_EOL,
- SCM_UNDEFINED));
-
- Array<Real> a;
- for (SCM i = quants; gh_pair_p (i); i = ly_cdr (i))
- a.push (gh_scm2double (ly_car (i)));
-
- if (a.size () <= 1)
- return pos;
-
- bounds[d] = quantise_iv (a, pos[d]*dir/staff_space) * staff_space;
- }
- while (flip (&d) != LEFT);
-
- Real ady = abs (dy);
-
- // quant direction hints disabled for now
- int q = 0;//(int)quant_dir;
-
- /* TODO: make smart choice, find best left/right quants pair.
-
- Slope should never be steeper than least_squares (before damping)
- (save that value?)
- Slope should never be reduced to zero.
- */
- SCM s = me->get_grob_property ("least-squares-dy");
- Real lsdy = gh_number_p (s) ? gh_scm2double (s) : 0;
-
- // Interval qpos (0, 1000 * sign (dy));
- Interval qpos;
- Real epsilon = staff_space / 10;
- Direction ldir = LEFT;
- do
- {
- Direction rdir = LEFT;
- do
- {
- Interval i (bounds[LEFT][ldir]*dir, bounds[RIGHT][rdir]*dir);
- if ((!lsdy
- || (abs (i.delta ()) <= abs (lsdy) + epsilon
- && sign (i.delta ()) == sign (lsdy)))
- && (abs (abs (i.delta ()) - ady)
- <= abs (abs (qpos.delta ()) - ady))
- && sign (i.delta ()) == sign (pos.delta ())
- && (!q
- || (i[LEFT]*q >= pos[LEFT]*q && i[RIGHT]*q
- >= pos[RIGHT]*q)))
- qpos = i;
- }
- while (flip (&rdir) != LEFT);
- }
- while (flip (&ldir) != LEFT);
-
- return qpos;
+ return SCM_UNSPECIFIED;
}
+/*
+ Calculate the Y position of the stem-end, given the Y-left, Y-right
+ in POS, and for stem S.
-/* Quantise vertical position (left and right) of beam.
- Generalisation of [Ross]. */
-MAKE_SCHEME_CALLBACK (Beam, quantise_position, 1);
-SCM
-Beam::quantise_position (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
-
- Interval pos = ly_scm2interval (me->get_grob_property ("positions"));
- Real y_shift = check_stem_length_f (me, pos);
- pos += y_shift;
- Real staff_space = Staff_symbol_referencer::staff_space (me);
-
- Direction dir = Directional_element_interface::get (me);
- for (int i = 0; i < 10; i++)
- {
- Interval qpos = quantise_interval (me, pos, CENTER);
- // how to check for uninitised interval, (inf, -inf)?
- if (qpos[LEFT] < 1000)
- {
- y_shift = check_stem_length_f (me, qpos);
- if (y_shift * dir < staff_space / 2)
- {
- pos = qpos;
- break;
- }
- }
- pos += ((i + 1) * ((i % 2) * -2 + 1)) * dir * staff_space / 4;
- }
-
-
- me->set_grob_property ("positions", ly_interval2scm (pos));
- set_stem_lengths (me);
-
-#if 0
- pos = ly_scm2interval (me->get_grob_property ("positions"));
-
- y_shift = check_stem_length_f (me, pos);
-
- Real half_space = Staff_symbol_referencer::staff_space (me) / 2;
- /* HMMM */
- if (y_shift > half_space / 4)
- {
- pos += y_shift;
- int quant_dir = 0;
- /* for significantly lengthened or shortened stems,
- request quanting the other way.
- HMMM */
- if (abs (y_shift) > half_space / 2)
- quant_dir = sign (y_shift) * Directional_element_interface::get (me);
- pos = quantise_interval (me, pos, (Direction)quant_dir);
- }
-
- me->set_grob_property ("positions", ly_interval2scm (pos));
-#endif
-
- return SCM_UNSPECIFIED;
-}
+ If CORRECT, correct for multiplicity of beam in case of knees.
-MAKE_SCHEME_CALLBACK (Beam, end_after_line_breaking, 1);
-SCM
-Beam::end_after_line_breaking (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
- set_stem_lengths (me);
-
- return SCM_UNSPECIFIED;
-}
+ TODO: junk CORRECT from this.
+ */
Real
-Beam::calc_stem_y_f (Grob *me, Item* s, Interval pos)
+Beam::calc_stem_y (Grob *me, Grob* s, Interval pos, bool correct)
{
int beam_multiplicity = get_multiplicity (me);
- int stem_multiplicity = (Stem::flag_i (s) - 2) >? 0;
-
- SCM space_proc = me->get_grob_property ("space-function");
- SCM space = gh_call1 (space_proc, gh_int2scm (beam_multiplicity));
+ int stem_multiplicity = (Stem::duration_log (s) - 2) >? 0;
+
Real thick = gh_scm2double (me->get_grob_property ("thickness"));
- Real interbeam_f = gh_scm2double (space);
+ Real interbeam = get_interbeam (me);
// ugh -> use commonx
- Real x0 = first_visible_stem (me)->relative_coordinate (0, X_AXIS);
- Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - x0;
+ Grob * fvs = first_visible_stem (me);
+ Grob *lvs = last_visible_stem (me);
+
+ Real x0 = fvs ? fvs->relative_coordinate (0, X_AXIS) : 0.0;
+ Real dx = fvs ? lvs->relative_coordinate (0, X_AXIS) - x0 : 0.0;
+ Real r = s->relative_coordinate (0, X_AXIS) - x0;
Real dy = pos.delta ();
Real stem_y = (dy && dx
- ? (s->relative_coordinate (0, X_AXIS) - x0) / dx
+ ? r / dx
* dy
: 0) + pos[LEFT];
- /* knee */
- Direction dir = Directional_element_interface::get (me);
- Direction sdir = Directional_element_interface::get (s);
-
- /* knee */
- if (dir!= sdir)
- {
- stem_y -= dir * (thick / 2 + (beam_multiplicity - 1) * interbeam_f);
-
- // huh, why not for first visible?
- if (Staff_symbol_referencer::staff_symbol_l (s)
- != Staff_symbol_referencer::staff_symbol_l (last_visible_stem (me)))
- stem_y += Directional_element_interface::get (me)
- * (beam_multiplicity - stem_multiplicity) * interbeam_f;
- }
-
- return stem_y;
-}
-
-/* Make very sure that we don't have stems that are too short.
- Try our best not to have stems that are too long (think: knees).
-
- Optionally (testing): try to lengthen more, to reach more ideal
- stem lengths */
-Real
-Beam::check_stem_length_f (Grob *me, Interval pos)
-{
- Real shorten = 0;
- Real lengthen = 0;
- Direction dir = Directional_element_interface::get (me);
-
- Link_array<Item> stems=
- Pointer_group_interface__extract_grobs (me, (Item*)0, "stems");
+ Direction my_dir = Directional_element_interface::get (s);
+ Direction first_dir = fvs? Directional_element_interface::get (fvs) : my_dir;
- bool knee = false;
- int ideal_lengthen_count = 0;
- Real ideal_lengthen = 0;
- int ideal_shorten_count = 0;
- Real ideal_shorten = 0;
-
- for (int i=0; i < stems.size (); i++)
+ if (correct && my_dir != first_dir)
{
- Item* s = stems[i];
- if (Stem::invisible_b (s))
- continue;
-
- knee |= dir != Directional_element_interface::get (s);
-
- Real stem_y = calc_stem_y_f (me, s, pos);
+ /*
+ WTF is happening here ?
+
+ It looks as if this is some kind of fixup for multiple kneed
+ beams to get a piece of stem at the #.
+
+
+ x
+ |
+ =======|
+ |======#
+ |
+ |
+ x
+
+ Rules for this kind of stuff are hairy. In any event, the
+ current stem should look at the multiplicity of its
+ predecessor.
+
+ --hwn.
+
+ */
- stem_y *= dir;
- Stem_info info = Stem::calc_stem_info (s);
+ // FIXME, hairy stuff
+ stem_y += my_dir * (thick / 2 + (beam_multiplicity - 1) * interbeam);
- shorten = shorten <? info.maxy_f_ - stem_y;
- lengthen = lengthen >? info.miny_f_ - stem_y;
+ // huh, why not for first visible?
- if (info.idealy_f_ - stem_y > 0)
- {
-#if 0
- ideal_lengthen += info.idealy_f_ - stem_y;
- ideal_lengthen_count++;
-#else
- ideal_lengthen = ideal_lengthen >? info.idealy_f_ - stem_y;
- ideal_lengthen_count = 1;
-#endif
- }
- else if (info.idealy_f_ - stem_y < 0)
+ /*
+ What the heck is happening here??
+ */
+ Grob *last_visible = last_visible_stem (me);
+ if (last_visible)
{
-#if 0
- ideal_shorten += info.idealy_f_ - stem_y;
- ideal_shorten_count++;
-#else
- ideal_shorten = ideal_shorten <? info.idealy_f_ - stem_y;
- ideal_shorten_count = 1;
-#endif
+ if ( Staff_symbol_referencer::staff_symbol_l (s)
+ != Staff_symbol_referencer::staff_symbol_l (last_visible))
+ stem_y += Directional_element_interface::get (me)
+ * (beam_multiplicity - stem_multiplicity) * interbeam;
}
+ else
+ programming_error ("No last visible stem");
}
-
- if (lengthen && shorten)
- me->warning (_ ("weird beam vertical offset"));
-
- if (ideal_lengthen_count)
- lengthen = (ideal_lengthen / ideal_lengthen_count) >? lengthen;
- if (knee && ideal_shorten_count)
- shorten = (ideal_shorten / ideal_shorten_count) <? shorten;
-
- if (lengthen && shorten)
- return dir * (lengthen + shorten);
-
- return dir * (shorten ? shorten : lengthen);
+ return stem_y;
}
/*
if (!Stem::invisible_b (stems[i]))
common = common->common_refpoint (stems[i], Y_AXIS);
- Direction dir = Directional_element_interface::get (me);
Interval pos = ly_scm2interval (me->get_grob_property ("positions"));
Real staff_space = Staff_symbol_referencer::staff_space (me);
+
+ /*
+ DOCUMENT THIS.
+ */
+#if 0
Real thick = gh_scm2double (me->get_grob_property ("thickness"));
+ Direction dir = Directional_element_interface::get (me);
bool ps_testing = to_boolean (ly_symbol2scm ("ps-testing"));
+#endif
+
for (int i=0; i < stems.size (); i++)
{
Item* s = stems[i];
if (Stem::invisible_b (s))
continue;
- Real stem_y = calc_stem_y_f (me, s, pos);
+ Real stem_y = calc_stem_y (me, s, pos, true);
+#if 0
// doesn't play well with dvips
if (ps_testing)
if (Stem::get_direction (s) == dir)
stem_y += Stem::get_direction (s) * thick / 2;
+#endif
/* caution: stem measures in staff-positions */
Real id = me->relative_coordinate (common, Y_AXIS)
/*
beams to go with one stem.
- FIXME: clean me up.
+ FIXME: clean me up:
+
+ The beam should be constructed by one function that knows where the
+ X and Y points are, and only inspects the stems to obtain
+ multiplicity and stem directions.
+
*/
Molecule
Beam::stem_beams (Grob *me, Item *here, Item *next, Item *prev, Real dydx)
{
// ugh -> use commonx
if ((next
- && !(next->relative_coordinate (0, X_AXIS)
+ && ! (next->relative_coordinate (0, X_AXIS)
> here->relative_coordinate (0, X_AXIS)))
|| (prev
- && !(prev->relative_coordinate (0, X_AXIS)
+ && ! (prev->relative_coordinate (0, X_AXIS)
< here->relative_coordinate (0, X_AXIS))))
programming_error ("Beams are not left-to-right");
- int multiplicity = get_multiplicity (me);
-
- SCM space_proc = me->get_grob_property ("space-function");
- SCM space = gh_call1 (space_proc, gh_int2scm (multiplicity));
-
Real thick = gh_scm2double (me->get_grob_property ("thickness"));
- Real interbeam_f = gh_scm2double (space);
-
- Real bdy = interbeam_f;
+ Real bdy = get_interbeam (me);
Molecule leftbeams;
Molecule rightbeams;
Real nw_f;
if (!Stem::first_head (here))
nw_f = 0;
- else {
- int t = Stem::type_i (here);
-
- SCM proc = me->get_grob_property ("flag-width-function");
- SCM result = gh_call1 (proc, gh_int2scm (t));
- nw_f = gh_scm2double (result);
- }
+ else
+ {
+ int t = Stem::duration_log (here);
+ SCM proc = me->get_grob_property ("flag-width-function");
+ SCM result = gh_call1 (proc, gh_int2scm (t));
+ nw_f = gh_scm2double (result);
+ }
- Direction dir = Directional_element_interface::get (me);
/* [Tremolo] beams on whole notes may not have direction set? */
- if (dir == CENTER)
- dir = Directional_element_interface::get (here);
-
+ Direction dir = Directional_element_interface::get (here);
/* half beams extending to the left. */
if (prev)
- prev->relative_coordinate (0, X_AXIS);
Real stem_w = gh_scm2double (prev->get_grob_property ("thickness"))
// URG
- * me->paper_l ()->get_var ("stafflinethickness");
+ * me->paper_l ()->get_var ("linethickness");
w = w/2 <? nw_f;
Molecule a;
Real stem_w = gh_scm2double (next->get_grob_property ("thickness"))
// URG
- * me->paper_l ()->get_var ("stafflinethickness");
+ * me->paper_l ()->get_var ("linethickness");
Molecule a = Lookup::beam (dydx, w + stem_w, thick);
a.translate_axis (- stem_w/2, X_AXIS);
}
leftbeams.add_molecule (rightbeams);
- /* Does beam quanting think of the asymetry of beams?
- Refpoint is on bottom of symbol. (FIXTHAT) --hwn. */
return leftbeams;
}
+
MAKE_SCHEME_CALLBACK (Beam, brew_molecule, 1);
SCM
Beam::brew_molecule (SCM smob)
dx = stems.top ()->relative_coordinate (0, X_AXIS) - x0;
}
- Interval pos = ly_scm2interval (me->get_grob_property ("positions"));
+ SCM posns = me->get_grob_property ("positions");
+ Interval pos;
+ if (!ly_number_pair_p (posns))
+ {
+ programming_error ("No beam posns");
+ pos = Interval (0,0);
+ }
+ else
+ pos= ly_scm2interval (posns);
Real dy = pos.delta ();
Real dydx = dy && dx ? dy/dx : 0;
+
for (int i=0; i < stems.size (); i++)
{
Item *item = stems[i];
Item *prev = (i > 0)? stems[i-1] : 0;
Item *next = (i < stems.size ()-1) ? stems[i+1] :0;
+
+
Molecule sb = stem_beams (me, item, next, prev, dydx);
Real x = item->relative_coordinate (0, X_AXIS) - x0;
sb.translate (Offset (x, x * dydx + pos[LEFT]));
+
+
mol.add_molecule (sb);
}
->get_bound (LEFT)->relative_coordinate (0, X_AXIS),
X_AXIS);
+#if (DEBUG_QUANTING)
+ {
+ /*
+ This code prints the demerits for each beam. Perhaps this
+ should be switchable for those who want to twiddle with the
+ parameters.
+ */
+ String str;
+ if (1)
+ {
+ str += to_str (gh_scm2int (me->get_grob_property ("best-idx")));
+ str += ":";
+ }
+ str += to_str (gh_scm2double (me->get_grob_property ("quant-score")),
+ "%.2f");
+
+ SCM properties = Font_interface::font_alist_chain (me);
+
+
+ Molecule tm = Text_item::text2molecule (me, ly_str02scm (str.ch_C ()), properties);
+ mol.add_at_edge (Y_AXIS, UP, tm, 5.0);
+ }
+#endif
+
return mol.smobbed_copy ();
}
if (Stem::invisible_b (s))
continue;
- if (((int)Stem::chord_start_f (s))
+ if (((int)Stem::chord_start_y (s))
&& (Stem::get_direction (s) != Stem::get_default_dir (s)))
f++;
}
-/* TODO:
- use filter and standard list functions.
- */
int
Beam::visible_stem_count (Grob *me)
{
/*
[TODO]
+
handle rest under beam (do_post: beams are calculated now)
what about combination of collisions and rest under beam.
Direction d = Stem::get_direction (stem);
Real beamy = (stem->relative_coordinate (0, X_AXIS) - x0) * dydx + pos[LEFT];
- Real staff_space = Staff_symbol_referencer::staff_space (rest);
+ Real staff_space = Staff_symbol_referencer::staff_space (rest);
Real rest_dim = rest->extent (rest, Y_AXIS)[d]*2.0 / staff_space; // refp??
}
-bool
-Beam::has_interface (Grob *me)
-{
- return me->has_interface (ly_symbol2scm ("beam-interface"));
-}
+
+
+ADD_INTERFACE (Beam, "beam-interface",
+ "A beam.
+
+#'thickness= weight of beams, in staffspace
+
+
+We take the least squares line through the ideal-length stems, and
+then damp that using
+
+ damped = tanh (slope)
+
+this gives an unquantized left and right position for the beam end.
+Then we take all combinations of quantings near these left and right
+positions, and give them a score (according to how close they are to
+the ideal slope, how close the result is to the ideal stems, etc.). We
+take the best scoring combination.
+
+",
+ "position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");
+
projects / lilypond.git / blobdiff