/*
beam.cc -- implement Beam
-
+
source file of the GNU LilyPond music typesetter
-
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- Jan Nieuwenhuizen <janneke@gnu.org>
-
+
+ (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
*/
/*
- [TODO]
- * less hairy code
- * move paper vars to scm
+TODO:
+
+ - Determine auto knees based on positions if it's set by the user.
+
+ - the code is littered with * and / staff_space calls for
+ #'positions. Consider moving to real-world coordinates?
+
+ Problematic issue is user tweaks (user tweaks are in staff-coordinates.)
+
+Notes:
+
+ - Stems run to the Y-center of the beam.
+
+ - beam_translation is the offset between Y centers of the beam.
*/
+
+#include <math.h> // tanh.
+
+#include "molecule.hh"
+#include "directional-element-interface.hh"
#include "beaming.hh"
-#include "dimensions.hh"
#include "beam.hh"
#include "misc.hh"
-#include "debug.hh"
-#include "leastsquares.hh"
+#include "least-squares.hh"
#include "stem.hh"
#include "paper-def.hh"
#include "lookup.hh"
#include "group-interface.hh"
#include "staff-symbol-referencer.hh"
-#include "cross-staff.hh"
+#include "item.hh"
+#include "spanner.hh"
+#include "warn.hh"
+
+bool debug_beam_quanting_flag;
+
+
+#if DEBUG_QUANTING
+#include "text-item.hh" // debug output.
+#include "font-interface.hh" // debug output.
+#endif
-Beam::Beam ()
-{
- Group_interface g (this, "stems");
- g.set_interface ();
-}
void
-Beam::add_stem (Stem*s)
+Beam::add_stem (Grob *me, Grob *s)
{
- Group_interface gi (this, "stems");
- gi.add_element (s);
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s);
- s->add_dependency (this);
+ s->add_dependency (me);
- assert (!s->beam_l ());
- s->set_elt_property ("beam", self_scm_);
+ assert (!Stem::get_beam (s));
+ s->set_grob_property ("beam", me->self_scm ());
+
+ add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (s));
+}
- if (!spanned_drul_[LEFT])
- set_bounds (LEFT,s);
+
+Real
+Beam::get_thickness (Grob * me)
+{
+ return robust_scm2double (me->get_grob_property ("thickness"), 0)
+ * Staff_symbol_referencer::staff_space (me);
+}
+
+/* Return the translation between 2 adjoining beams. */
+Real
+Beam::get_beam_translation (Grob *me)
+{
+ SCM func = me->get_grob_property ("space-function");
+
+ if (gh_procedure_p (func))
+ {
+ SCM s = gh_call2 (func, me->self_scm (), scm_int2num (get_beam_count (me)));
+ return gh_scm2double (s);
+ }
else
- set_bounds (RIGHT,s);
+ {
+ return 0.81;
+ }
}
+/* Maximum beam_count. */
int
-Beam::get_multiplicity () const
+Beam::get_beam_count (Grob *me)
{
int m = 0;
- for (SCM s = get_elt_property ("stems"); gh_pair_p (s); s = gh_cdr (s))
+ for (SCM s = me->get_grob_property ("stems"); gh_pair_p (s); s = ly_cdr (s))
{
- Score_element * sc = unsmob_element (gh_car (s));
-
- if (Stem * st = dynamic_cast<Stem*> (sc))
- m = m >? st->beam_count (LEFT) >? st->beam_count (RIGHT);
+ Grob *stem = unsmob_grob (ly_car (s));
+ m = m >? (Stem::beam_multiplicity (stem).length () + 1);
}
return m;
}
+
/*
- After pre-processing all directions should be set.
- Several post-processing routines (stem, slur, script) need stem/beam
- direction.
- Currenly, this means that beam has set all stem's directions.
- [Alternatively, stems could set its own directions, according to
- their beam, during 'final-pre-processing'.]
+ Space return space between beams.
*/
-void
-Beam::do_pre_processing ()
+MAKE_SCHEME_CALLBACK (Beam, space_function, 2);
+SCM
+Beam::space_function (SCM smob, SCM beam_count)
{
- // Why?
- if (visible_stem_count () < 2)
+ Grob *me = unsmob_grob (smob);
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ Real line = Staff_symbol_referencer::line_thickness (me);
+ Real thickness = get_thickness (me);
+
+ Real beam_translation = gh_scm2int (beam_count) < 4
+ ? (2*staff_space + line - thickness) / 2.0
+ : (3*staff_space + line - thickness) / 3.0;
+
+ return gh_double2scm (beam_translation);
+}
+
+
+/* After pre-processing all directions should be set.
+ Several post-processing routines (stem, slur, script) need stem/beam
+ direction.
+ Currenly, this means that beam has set all stem's directions.
+ [Alternatively, stems could set its own directions, according to
+ their beam, during 'final-pre-processing'.] */
+MAKE_SCHEME_CALLBACK (Beam, before_line_breaking, 1);
+SCM
+Beam::before_line_breaking (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ /* Beams with less than 2 two stems don't make much sense, but could happen
+ when you do
+
+ [r8 c8 r8].
+
+ For a beam that only has one stem, we try to do some disappearance magic:
+ we revert the flag, and move on to The Eternal Engraving Fields. */
+
+ int count = visible_stem_count (me);
+ if (count < 2)
+ {
+ me->warning (_ ("beam has less than two visible stems"));
+
+ SCM stems = me->get_grob_property ("stems");
+ if (scm_ilength (stems) == 1)
+ {
+ me->warning (_ ("Beam has less than two stems. Removing beam."));
+
+ unsmob_grob (gh_car (stems))->set_grob_property ("beam", SCM_EOL);
+ me->suicide ();
+
+ return SCM_UNSPECIFIED;
+ }
+ else if (scm_ilength (stems) == 0)
+ {
+ me->suicide ();
+ return SCM_UNSPECIFIED;
+ }
+ }
+ if (count >= 1)
{
- warning (_ ("beam has less than two stems"));
- set_elt_property ("transparent", SCM_BOOL_T);
+ Direction d = get_default_dir (me);
+
+ consider_auto_knees (me);
+ set_stem_directions (me, d);
+
+ connect_beams (me);
+
+ set_stem_shorten (me);
}
- if (!get_direction ())
- set_direction (get_default_dir ());
+ return SCM_EOL;
+}
+
- auto_knees ();
- set_stem_directions ();
+/*
+ We want a maximal number of shared beams, but if there is choice, we
+ take the one that is closest to the end of the stem. This is for situations like
+
+ x
+ |
+ |
+ |===|
+ |=
+ |
+ x
+
+
+ */
+int
+position_with_maximal_common_beams (SCM left_beaming, SCM right_beaming,
+ Direction left_dir,
+ Direction right_dir)
+{
+ Slice lslice = int_list_to_slice (gh_cdr (left_beaming));
+
+ int best_count = 0;
+ int best_start = 0;
+ for (int i = lslice[-left_dir];
+ (i - lslice[left_dir])* left_dir <= 0 ; i+= left_dir)
+ {
+ int count =0;
+ for ( SCM s = gh_car (right_beaming); gh_pair_p (s); s = gh_cdr (s))
+ {
+ int k = - right_dir * gh_scm2int (gh_car (s)) + i;
+ if (scm_memq (scm_int2num (k), left_beaming) != SCM_BOOL_F)
+ count ++;
+ }
+
+ if (count >= best_count)
+ {
+ best_count = count;
+ best_start = i;
+ }
+ }
- set_stem_shorten ();
+ return best_start;
}
+void
+Beam::connect_beams (Grob *me)
+{
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+
+ Slice last_int;
+ last_int.set_empty();
+ SCM last_beaming = SCM_EOL;
+ Direction last_dir = CENTER;
+ for (int i = 0; i< stems.size(); i++)
+ {
+ Grob *this_stem = stems[i];
+ SCM this_beaming = this_stem->get_grob_property ("beaming");
+
+ Direction this_dir = get_grob_direction (this_stem);
+ if (gh_pair_p (last_beaming) && gh_pair_p (this_beaming))
+ {
+ int start_point = position_with_maximal_common_beams
+ (last_beaming, this_beaming,
+ last_dir, this_dir);
+
+ Direction d = LEFT;
+ Slice new_slice ;
+ do
+ {
+ if (d == RIGHT && i == stems.size()-1)
+ continue;
+
+ new_slice.set_empty();
+ SCM s = index_get_cell (this_beaming, d);
+ for (; gh_pair_p (s); s = gh_cdr (s))
+ {
+ int new_beam_pos =
+ start_point - this_dir * gh_scm2int (gh_car (s));
+
+ new_slice.add_point (new_beam_pos);
+ gh_set_car_x (s, scm_int2num (new_beam_pos));
+ }
+
+
+ }
+ while (flip (&d) != LEFT);
+
+ if (!new_slice.is_empty ())
+ last_int = new_slice;
+ }
+ else
+ {
+ gh_set_car_x ( this_beaming, SCM_EOL);
+ SCM s = gh_cdr (this_beaming);
+ for (; gh_pair_p (s); s = gh_cdr (s))
+ {
+ int np = - this_dir * gh_scm2int (gh_car(s));
+ gh_set_car_x (s, scm_int2num (np));
+ last_int.add_point (np);
+ }
+ }
+
+ if (i == stems.size () -1)
+ {
+ gh_set_cdr_x (this_beaming, SCM_EOL);
+ }
+
+ if (scm_ilength (gh_cdr (this_beaming)) > 0)
+ {
+ last_beaming = this_beaming;
+ last_dir = this_dir;
+ }
+ }
+ }
+
+
/*
- FIXME
+ TODO: should not make beams per stem, but per Y-level.
*/
+MAKE_SCHEME_CALLBACK (Beam, brew_molecule, 1);
+SCM
+Beam::brew_molecule (SCM grob)
+{
+ Grob *me = unsmob_grob (grob);
+ position_beam (me);
+
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+ Grob* xcommon = common_refpoint_of_array (stems, me, X_AXIS);
+
+ Real x0, dx;
+ if (visible_stem_count (me))
+ {
+ // ugh -> use commonx
+ x0 = first_visible_stem (me)->relative_coordinate (xcommon, X_AXIS);
+ dx = last_visible_stem (me)->relative_coordinate (xcommon, X_AXIS) - x0;
+ }
+ else
+ {
+ x0 = stems[0]->relative_coordinate (xcommon, X_AXIS);
+ dx = stems.top ()->relative_coordinate (xcommon, X_AXIS) - x0;
+ }
+
+ SCM posns = me->get_grob_property ("positions");
+ Drul_array<Real> pos;
+ if (!is_number_pair (posns))
+ {
+ programming_error ("No beam posns");
+ pos = Interval (0,0);
+ }
+ else
+ pos= ly_scm2realdrul (posns);
+
+ scale_drul ( &pos, Staff_symbol_referencer::staff_space (me));
+
+ Real dy = pos[RIGHT] - pos[LEFT];
+ Real dydx = (dy && dx) ? dy/dx : 0;
+
+ Real thick = get_thickness (me);
+ Real bdy = get_beam_translation (me);
+
+ SCM last_beaming = SCM_EOL;
+ Real last_xposn = -1;
+ Real last_stem_width = -1 ;
+
+ Real gap_length =robust_scm2double ( me->get_grob_property ("gap"), 0.0);
+
+ Molecule the_beam;
+ Real lt = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
+
+ for (int i = 0; i<= stems.size(); i++)
+ {
+ Grob * st = (i < stems.size()) ? stems[i] : 0;
+
+ SCM this_beaming = st ? st->get_grob_property ("beaming") : SCM_EOL;
+ Real xposn = st ? st->relative_coordinate (xcommon, X_AXIS) : 0.0;
+ Real stem_width = st ? robust_scm2double (st->get_grob_property ("thickness"), 1.0) *lt : 0 ;
+ Direction stem_dir = st ? to_dir (st->get_grob_property ("direction")) : CENTER;
+ /*
+ We do the space left of ST, with lfliebertjes pointing to the
+ right from the left stem, and rfliebertjes pointing left from
+ right stem.
+ */
+ SCM left = (i>0) ? gh_cdr (last_beaming) : SCM_EOL;
+ SCM right = st ? gh_car (this_beaming) : SCM_EOL;
+
+ Array<int> full_beams;
+ Array<int> lfliebertjes;
+ Array<int> rfliebertjes;
+
+ for (SCM s = left;
+ gh_pair_p (s); s =gh_cdr (s))
+ {
+ int b = gh_scm2int (gh_car (s));
+ if (scm_memq (gh_car(s), right) != SCM_BOOL_F)
+ {
+ full_beams.push (b);
+ }
+ else
+ {
+ lfliebertjes.push (b);
+ }
+ }
+ for (SCM s = right;
+ gh_pair_p (s); s =gh_cdr (s))
+ {
+ int b = gh_scm2int (gh_car (s));
+ if (scm_memq (gh_car(s), left) == SCM_BOOL_F)
+ {
+ rfliebertjes.push (b);
+ }
+ }
+
+ /*
+ how much to stick out for beams across linebreaks
+ */
+ Real break_overshoot = 3.0;
+ Real w = (i > 0 && st) ? xposn - last_xposn : break_overshoot;
+
+ Real stem_offset =0.0;
+ if (i > 0)
+ {
+ w += last_stem_width / 2;
+ stem_offset = -last_stem_width / 2;
+ }
+
+ if (st)
+ w += stem_width/ 2 ;
+
+
+ Real blot = me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
+ Molecule whole = Lookup::beam (dydx, w, thick, blot);
+ Molecule gapped;
+
+ int gap_count = 0;
+ if (gh_number_p (me->get_grob_property ("gap-count")))
+ {
+ gap_count = gh_scm2int (me->get_grob_property ("gap-count"));
+ gapped = Lookup::beam (dydx, w - 2 * gap_length, thick, blot);
+
+ full_beams.sort (default_compare);
+ if (stem_dir == UP)
+ full_beams.reverse ();
+ }
+
+ int k = 0;
+ for (int j = full_beams.size (); j--;)
+ {
+ Molecule b (whole);
+
+ if (k++ < gap_count)
+ {
+ b = gapped;
+ b.translate_axis (gap_length, X_AXIS);
+ }
+ b.translate_axis (last_xposn - x0 + stem_offset, X_AXIS);
+ b.translate_axis (dydx * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
+
+ the_beam.add_molecule (b);
+ }
+
+
+
+ if (lfliebertjes.size() || rfliebertjes.size())
+ {
+ Real nw_f;
+
+ if (st)
+ {
+ int t = Stem::duration_log (st);
+
+ SCM proc = me->get_grob_property ("flag-width-function");
+ SCM result = gh_call1 (proc, scm_int2num (t));
+ nw_f = gh_scm2double (result);
+ }
+ else
+ nw_f = break_overshoot;
+
+ /* Half beam should be one note-width,
+ but let's make sure two half-beams never touch */
+ Real w = (i>0 && st) ? (xposn - last_xposn) : break_overshoot;
+ w = w/2 <? nw_f;
+
+ Molecule half = Lookup::beam (dydx, w, thick, blot);
+ for (int j = lfliebertjes.size(); j--;)
+ {
+ Molecule b (half);
+ b.translate_axis (last_xposn - x0, X_AXIS);
+ b.translate_axis (dydx * (last_xposn-x0) + bdy * lfliebertjes[j], Y_AXIS);
+ the_beam.add_molecule (b);
+ }
+ for (int j = rfliebertjes.size(); j--;)
+ {
+ Molecule b (half);
+ b.translate_axis (xposn - x0 - w , X_AXIS);
+ b.translate_axis (dydx * (xposn-x0 -w) + bdy * rfliebertjes[j], Y_AXIS);
+ the_beam.add_molecule (b);
+ }
+ }
+
+
+ last_xposn = xposn;
+ last_stem_width = stem_width;
+ last_beaming = this_beaming;
+ }
+
+ the_beam.translate_axis (x0 - me->relative_coordinate (xcommon, X_AXIS), X_AXIS);
+ the_beam.translate_axis (pos[LEFT], Y_AXIS);
+
+#if (DEBUG_QUANTING)
+ SCM quant_score = me->get_grob_property ("quant-score");
+ if (debug_beam_quanting_flag
+ && gh_string_p (quant_score))
+ {
+
+ /*
+ This code prints the demerits for each beam. Perhaps this
+ should be switchable for those who want to twiddle with the
+ parameters.
+ */
+ String str;
+ SCM properties = Font_interface::font_alist_chain (me);
+
+ Molecule tm = *unsmob_molecule (Text_item::interpret_markup
+ (me->get_paper ()->self_scm (), properties, quant_score));
+ the_beam.add_at_edge (Y_AXIS, UP, tm, 5.0, 0);
+ }
+#endif
+
+
+
+ return the_beam.smobbed_copy();
+}
+
+
+
+
Direction
-Beam::get_default_dir () const
+Beam::get_default_dir (Grob *me)
{
Drul_array<int> total;
total[UP] = total[DOWN] = 0;
count[UP] = count[DOWN] = 0;
Direction d = DOWN;
- for (int i=0; i <stem_count (); i++)
- do { // HUH -- waar slaat dit op?
- Stem *s = stem (i);
- int current = s->get_direction ()
- ? (1 + d * s->get_direction ())/2
- : s->get_center_distance ((Direction)-d);
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+
+ for (int i=0; i <stems.size (); i++)
+ do {
+ Grob *s = stems[i];
+ Direction sd = get_grob_direction (s);
+
+ 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");
+ SCM s = gh_call2 (func,
+ gh_cons (scm_int2num (count[UP]),
+ scm_int2num (count[DOWN])),
+ gh_cons (scm_int2num (total[UP]),
+ scm_int2num (total[DOWN])));
+
+ if (gh_number_p (s) && gh_scm2int (s))
+ return to_dir (s);
+
+ /* If dir is not determined: get default */
+ return to_dir (me->get_grob_property ("neutral-direction"));
+}
+
- } while (flip(&d) != DOWN);
+/* Set all stems with non-forced direction to beam direction.
+ Urg: non-forced should become `without/with unforced' direction,
+ once stem gets cleaned-up. */
+void
+Beam::set_stem_directions (Grob *me, Direction d)
+{
+ Link_array<Grob> stems
+ =Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
- /*
- [Ross] states that the majority of the notes dictates the
- direction (and not the mean of "center distance")
+ for (int i=0; i <stems.size (); i++)
+ {
+ Grob *s = stems[i];
+
+ SCM forcedir = s->get_grob_property ("direction");
+ if (!to_dir (forcedir))
+ set_grob_direction (s, d);
+ }
+}
- But is that because it really looks better, or because he wants
- to provide some real simple hands-on rules?
-
- We have our doubts, so we simply provide all sensible alternatives.
+/*
+ A union of intervals in the real line.
+
+ Abysmal performance (quadratic) for large N, hopefully we don't have
+ that large N. In any case, this should probably be rewritten to use
+ a balanced tree.
+ */
+struct Int_set
+{
+ Array<Interval> allowed_regions_;
+
+ Int_set()
+ {
+ set_full();
+ }
+
+ void set_full()
+ {
+ allowed_regions_.clear();
+ Interval s;
+ s.set_full ();
+ allowed_regions_.push (s);
+ }
+
+ void remove_interval (Interval rm)
+ {
+ for (int i = 0; i < allowed_regions_.size(); )
+ {
+ Interval s = rm;
+
+ s.intersect (allowed_regions_[i]);
+
+ if (!s.is_empty ())
+ {
+ Interval before = allowed_regions_[i];
+ Interval after = allowed_regions_[i];
+
+ before[RIGHT] = s[LEFT];
+ after[LEFT] = s[RIGHT];
+
+ if (!before.is_empty () && before.length () > 0.0)
+ {
+ allowed_regions_.insert (before, i);
+ i++;
+ }
+ allowed_regions_.del (i);
+ if (!after.is_empty () && after.length () > 0.0)
+ {
+ allowed_regions_.insert (after, i);
+ i++;
+ }
+ }
+ else
+ i++;
+ }
+ }
+};
+
+
+/*
+ Only try horizontal beams for knees. No reliable detection of
+ anything else is possible here, since we don't know funky-beaming
+ settings, or X-distances (slopes!) People that want sloped
+ knee-beams, should set the directions manually.
+ */
+void
+Beam::consider_auto_knees (Grob* me)
+{
+ SCM scm = me->get_grob_property ("auto-knee-gap");
+ if (!gh_number_p (scm))
+ return ;
- If dir is not determined: up (see stem::get_default_dir ()) */
+ Real threshold = gh_scm2double (scm);
+
+ Int_set gaps;
- Direction beam_dir = CENTER;
- Direction neutral_dir = (Direction)(int)paper_l ()->get_var ("stem_default_neutral_direction");
+ gaps.set_full ();
- SCM a = get_elt_property ("beam-dir-algorithm");
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+
+ Grob *common = common_refpoint_of_array (stems, me, Y_AXIS);
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
- if (a == ly_symbol2scm ("majority")) // should get default from paper.
- beam_dir = (count[UP] == count[DOWN]) ? neutral_dir
- : (count[UP] > count[DOWN]) ? UP : DOWN;
- else if (a == ly_symbol2scm ("mean"))
- // mean center distance
- beam_dir = (total[UP] == total[DOWN]) ? neutral_dir
- : (total[UP] > total[DOWN]) ? UP : DOWN;
- else if (a == ly_symbol2scm ("median"))
+ Array<Interval> hps_array;
+ for (int i=0; i < stems.size (); i++)
{
- // median center distance
- if (count[DOWN] && count[UP])
+ Grob* stem = stems[i];
+ if (Stem::invisible_b (stem))
+ continue;
+
+ Interval hps = Stem::head_positions (stem);
+ if(!hps.is_empty ())
{
- beam_dir = (total[UP] / count[UP] == total[DOWN] / count[DOWN])
- ? neutral_dir
- : (total[UP] / count[UP] > total[DOWN] / count[DOWN]) ? UP : DOWN;
+ hps[LEFT] += -1;
+ hps[RIGHT] += 1;
+ hps *= staff_space * 0.5 ;
+
+ /*
+ We could subtract beam Y position, but this routine only
+ sets stem directions, a constant shift does not have an
+ influence.
+
+ */
+ hps += stem->relative_coordinate (common, Y_AXIS);
+
+ if (to_dir (stem->get_grob_property ("direction")))
+ {
+ Direction stemdir = to_dir (stem->get_grob_property ("direction"));
+ hps[-stemdir] = - stemdir * infinity_f;
+ }
}
- else
+ hps_array.push (hps);
+
+ gaps.remove_interval (hps);
+ }
+
+ Interval max_gap;
+ Real max_gap_len =0.0;
+
+ for (int i = gaps.allowed_regions_.size() -1; i >= 0 ; i--)
+ {
+ Interval gap = gaps.allowed_regions_[i];
+
+ /*
+ the outer gaps are not knees.
+ */
+ if (isinf (gap[LEFT]) || isinf(gap[RIGHT]))
+ continue;
+
+ if (gap.length () >= max_gap_len)
+ {
+ max_gap_len = gap.length();
+ max_gap = gap;
+ }
+ }
+
+ if (max_gap_len > threshold)
+ {
+ int j = 0;
+ for (int i = 0; i < stems.size(); i++)
{
- beam_dir = (count[UP] == count[DOWN]) ? neutral_dir
- : (count[UP] > count[DOWN]) ? UP : DOWN;
+ Grob* stem = stems[i];
+ if (Stem::invisible_b (stem))
+ continue;
+
+ Interval hps = hps_array[j++];
+
+
+ Direction d = (hps.center () < max_gap.center()) ?
+ UP : DOWN ;
+
+ stem->set_grob_property ("direction", scm_int2num (d));
+
+ hps.intersect (max_gap);
+ assert (hps.is_empty () || hps.length () < 1e-6 );
}
}
+}
+
+
+
+/* Set stem's shorten property if unset.
+
+ TODO:
+ take some y-position (chord/beam/nearest?) into account
+ scmify forced-fraction
+
+ This is done in beam because the shorten has to be uniform over the
+ entire beam.
+
+*/
+void
+Beam::set_stem_shorten (Grob *me)
+{
+ /*
+ shortening looks silly for x staff beams
+ */
+ if (knee_b(me))
+ return ;
+
+ Real forced_fraction = 1.0 * forced_stem_count (me)
+ / visible_stem_count (me);
+
+ int beam_count = get_beam_count (me);
+
+ SCM shorten_list = me->get_grob_property ("beamed-stem-shorten");
+ if (shorten_list == SCM_EOL)
+ return;
+
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
- return beam_dir;
+ SCM shorten_elt =
+ robust_list_ref (beam_count -1, shorten_list);
+ Real shorten_f = gh_scm2double (shorten_elt) * staff_space;
+
+ /* your similar cute comment here */
+ shorten_f *= forced_fraction;
+
+ if (shorten_f)
+ me->set_grob_property ("shorten", gh_double2scm (shorten_f));
}
+/* Call list of y-dy-callbacks, that handle setting of
+ grob-properties
+
+*/
+MAKE_SCHEME_CALLBACK (Beam, after_line_breaking, 1);
+SCM
+Beam::after_line_breaking (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ position_beam (me);
+ return SCM_UNSPECIFIED;
+}
-/*
- Set all stems with non-forced direction to beam direction.
- Urg: non-forced should become `without/with unforced' direction,
- once stem gets cleaned-up.
- */
void
-Beam::set_stem_directions ()
+Beam::position_beam (Grob *me)
{
- Direction d = get_direction ();
- for (int i=0; i <stem_count (); i++)
+ if (to_boolean (me->get_grob_property ("positioning-done")))
+ return ;
+
+ me->set_grob_property ("positioning-done", SCM_BOOL_T);
+
+ /* Copy to mutable list. */
+ SCM s = ly_deep_copy (me->get_grob_property ("positions"));
+ me->set_grob_property ("positions", s);
+
+ if (ly_car (s) == SCM_BOOL_F)
{
- Stem *s = stem (i);
- SCM force = s->remove_elt_property ("dir-forced");
- if (!gh_boolean_p (force) || !gh_scm2bool (force))
- s->set_direction (d);
+ // 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), me->self_scm ());
}
-}
-void
-Beam::auto_knees ()
-{
- if (!auto_knee ("auto-interstaff-knee-gap", true))
- auto_knee ("auto-knee-gap", false);
+ set_stem_lengths (me);
}
-/*
- Simplistic auto-knees; only consider vertical gap between two
- adjacent chords.
- `Forced' stem directions are ignored. If you don't want auto-knees,
- don't set, or unset autoKneeGap/autoInterstaffKneeGap.
+/*
+ Compute a first approximation to the beam slope.
*/
-bool
-Beam::auto_knee (String gap_str, bool interstaff_b)
+MAKE_SCHEME_CALLBACK (Beam, least_squares, 1);
+SCM
+Beam::least_squares (SCM smob)
{
- bool knee_b = false;
- int knee_y = 0;
- SCM gap = get_elt_property (gap_str);
- if (gh_number_p (gap))
- {
- int auto_gap_i = gh_scm2int (gap);
- for (int i=1; i < stem_count (); i++)
- {
- bool is_b = (bool)(calc_interstaff_dist (stem (i), this)
- - calc_interstaff_dist (stem (i-1), this));
- int l_y = (int)(stem (i-1)->chord_start_f ())
- + (int)calc_interstaff_dist (stem (i-1), this);
- int r_y = (int)(stem (i)->chord_start_f ())
- + (int)calc_interstaff_dist (stem (i), this);
- int gap_i = r_y - l_y;
-
- if ((abs (gap_i) >= auto_gap_i) && (!interstaff_b || is_b))
- {
- knee_y = (r_y + l_y) / 2;
- knee_b = true;
- break;
- }
+ Grob *me = unsmob_grob (smob);
+
+ int count = visible_stem_count (me);
+ Interval pos (0, 0);
+
+ if (count < 1)
+ {
+ me->set_grob_property ("positions", ly_interval2scm (pos));
+ return SCM_UNSPECIFIED;
+ }
+
+
+ Array<Real> x_posns ;
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+ Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
+ Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
+
+ Real my_y = me->relative_coordinate (commony, Y_AXIS);
+
+ Grob *fvs = first_visible_stem (me);
+ Grob *lvs = last_visible_stem (me);
+
+ Interval ideal (Stem::get_stem_info (fvs).ideal_y_
+ + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
+ Stem::get_stem_info (lvs).ideal_y_
+ + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
+
+ Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
+ for (int i=0; i < stems.size (); i++)
+ {
+ Grob* s = stems[i];
+
+ Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
+ x_posns.push (x);
+ }
+ Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS) - x0;
+
+
+ Real y =0;
+ Real dydx = 0;
+ Real dy = 0;
+
+ if (!ideal.delta ())
+ {
+ Interval chord (Stem::chord_start_y (first_visible_stem (me)),
+ Stem::chord_start_y (last_visible_stem (me)));
+
+ /* Simple beams (2 stems) on middle line should be allowed to be
+ slightly sloped.
+
+ However, if both stems reach middle line,
+ ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
+
+ For that case, we apply artificial slope */
+ if (!ideal[LEFT] && chord.delta () && count == 2)
+ {
+ /* FIXME. -> UP */
+ Direction d = (Direction) (sign (chord.delta ()) * UP);
+ pos[d] = get_thickness (me) / 2;
+ pos[-d] = - pos[d];
}
+ else
+ {
+ pos = ideal;
+ }
+
+ /*
+ For broken beams this doesn't work well. In this case, the
+ slope esp. of the first part of a broken beam should predict
+ where the second part goes.
+ */
+ me->set_grob_property ("least-squares-dy",
+ gh_double2scm (pos[RIGHT] - pos[LEFT]));
}
- if (knee_b)
+ else
{
- for (int i=0; i < stem_count (); i++)
- {
- int y = (int)(stem (i)->chord_start_f ())
- + (int)calc_interstaff_dist (stem (i), this);
- stem (i)->set_direction (y < knee_y ? UP : DOWN);
- stem (i)->set_elt_property ("dir-forced", SCM_BOOL_T);
+ Array<Offset> ideals;
+ for (int i=0; i < stems.size (); i++)
+ {
+ Grob* s = stems[i];
+ if (Stem::invisible_b (s))
+ continue;
+ ideals.push (Offset (x_posns[i],
+ Stem::get_stem_info (s).ideal_y_
+ + s->relative_coordinate (commony, Y_AXIS)
+ - my_y));
}
+
+ minimise_least_squares (&dydx, &y, ideals);
+
+ dy = dydx * dx;
+ me->set_grob_property ("least-squares-dy", gh_double2scm (dy));
+ pos = Interval (y, (y+dy));
}
- return knee_b;
+
+ /*
+ "position" is relative to the staff.
+ */
+ scale_drul (&pos, 1/ Staff_symbol_referencer::staff_space (me));
+
+ me->set_grob_property ("positions", ly_interval2scm (pos));
+
+ return SCM_UNSPECIFIED;
}
+
/*
- Set stem's shorten property if unset.
- TODO: take some y-position (nearest?) into account
+ We can't combine with previous function, since check concave and
+ slope damping comes first.
+
+TODO: we should use the concaveness to control the amount of damping
+applied.
+
*/
-void
-Beam::set_stem_shorten ()
+MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 1);
+SCM
+Beam::shift_region_to_valid (SCM grob)
{
- if (!visible_stem_count ())
- return;
-
- Real forced_fraction = forced_stem_count () / visible_stem_count ();
- if (forced_fraction < 0.5)
- return;
-
- int multiplicity = get_multiplicity ();
- SCM shorten = scm_eval (scm_listify (
- ly_symbol2scm ("beamed-stem-shorten"),
- gh_int2scm (multiplicity),
- SCM_UNDEFINED));
- Real shorten_f = gh_scm2double (shorten)
- * Staff_symbol_referencer_interface (this).staff_space ();
+ Grob *me = unsmob_grob (grob);
+ /*
+ Code dup.
+ */
+ Array<Real> x_posns ;
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
+ Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
+ Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
- /* cute, but who invented this -- how to customise ? */
- if (forced_fraction < 1)
- shorten_f /= 2;
+ Grob *fvs = first_visible_stem (me);
- for (int i=0; i < stem_count (); i++)
+ if (!fvs)
+ return SCM_UNSPECIFIED;
+
+ Real x0 =fvs->relative_coordinate (commonx, X_AXIS);
+ for (int i=0; i < stems.size (); i++)
{
- Stem* s = stem (i);
- if (s->invisible_b ())
- continue;
- if (gh_number_p (s->get_elt_property ("shorten")))
- s->set_elt_property ("shorten", gh_double2scm (shorten_f));
+ Grob* s = stems[i];
+
+ Real x = s->relative_coordinate (commonx, X_AXIS) - x0;
+ x_posns.push (x);
}
-}
-/*
- Set elt properties height and y-position if not set.
- Adjust stem lengths to reach beam.
- */
-void
-Beam::do_post_processing ()
-{
- /* first, calculate y, dy */
- Real y, dy;
- calc_position_and_height (&y, &dy);
- if (suspect_slope_b (y, dy))
- dy = 0;
- Real damped_dy = calc_slope_damping_f (dy);
- Real quantised_dy = quantise_dy_f (damped_dy);
+ Grob *lvs = last_visible_stem (me);
+ if (!lvs)
+ return SCM_UNSPECIFIED;
+
+ Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0;
+
+ Drul_array<Real> pos = ly_scm2interval ( me->get_grob_property ("positions"));
+
+ scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
+
+ Real dy = pos[RIGHT] - pos[LEFT];
+ Real y = pos[LEFT];
+ Real dydx =dy/dx;
- y += (dy - quantised_dy) / 2;
- dy = quantised_dy;
/*
- until here, we used only stem_info, which acts as if dir=up
+ Shift the positions so that we have a chance of finding good
+ quants (i.e. no short stem failures.)
*/
- y *= get_direction ();
- dy *= get_direction ();
-
- /* set or read dy as necessary */
- SCM s = get_elt_property ("height");
- if (gh_number_p (s))
- dy = gh_scm2double (s);
- else
- set_elt_property ("height", gh_double2scm (dy));
-
- /* set or read y as necessary */
- s = get_elt_property ("y-position");
- if (gh_number_p (s))
+ Interval feasible_left_point;
+ feasible_left_point.set_full ();
+ for (int i=0; i < stems.size (); i++)
{
- y = gh_scm2double (s);
- set_stem_length (y, dy);
- }
- else
- {
- /* we can modify y, so we should quantise y */
- Real y_shift = check_stem_length_f (y, dy);
- y += y_shift;
- y = quantise_y_f (y, dy, 0);
- set_stem_length (y, dy);
- y_shift = check_stem_length_f (y, dy);
-
- Real internote_f = paper_l ()->get_var ("interline") / 2;
- if (y_shift > internote_f / 4)
- {
- y += y_shift;
+ Grob* s = stems[i];
+ if (Stem::invisible_b (s))
+ continue;
- /*
- for significantly lengthened or shortened stems,
- request quanting the other way.
- */
- int quant_dir = 0;
- if (abs (y_shift) > internote_f / 2)
- quant_dir = sign (y_shift) * get_direction ();
- y = quantise_y_f (y, dy, quant_dir);
- set_stem_length (y, dy);
- }
+ Direction d = Stem::get_direction (s);
- set_elt_property ("y-position", gh_double2scm (y));
- }
-}
+ Real left_y =
+ Stem::get_stem_info (s).shortest_y_
+ - dydx * x_posns [i];
-/*
- See Documentation/tex/fonts.doc
- */
-void
-Beam::calc_position_and_height (Real* y, Real* dy) const
-{
- *y = *dy = 0;
- if (visible_stem_count () <= 1)
- return;
+ /*
+ left_y is now relative to the stem S. We want relative to
+ ourselves, so translate:
+ */
+ left_y +=
+ + s->relative_coordinate (commony, Y_AXIS)
+ - me->relative_coordinate (commony, Y_AXIS);
+
+ Interval flp ;
+ flp.set_full ();
+ flp[-d] = left_y;
- Real first_ideal = first_visible_stem ()->calc_stem_info ().idealy_f_;
- if (first_ideal == last_visible_stem ()->calc_stem_info ().idealy_f_)
+ feasible_left_point.intersect (flp);
+ }
+
+ if (feasible_left_point.is_empty ())
{
- *dy = 0;
- *y = first_ideal;
- return;
+ warning (_("Not sure that we can find a nice beam slope (no viable initial configuration found)."));
}
-
- Least_squares ls;
- Real x0 = first_visible_stem ()->hpos_f ();
- for (int i=0; i < stem_count (); i++)
+ else if (!feasible_left_point.contains (y))
{
- Stem* s = stem (i);
- if (s->invisible_b ())
- continue;
- ls.input.push (Offset (s->hpos_f () - x0,
- s->calc_stem_info ().idealy_f_));
+ 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 ();
}
- Real dydx;
- ls.minimise (dydx, *y); // duh, takes references
-
- Real dx = last_visible_stem ()->hpos_f () - x0;
- *dy = dydx * dx;
+
+ pos = Drul_array<Real> (y, (y+dy));
+ scale_drul (&pos, 1/ Staff_symbol_referencer::staff_space (me));
+
+ me->set_grob_property ("positions", ly_interval2scm (pos));
+ return SCM_UNSPECIFIED;
}
-bool
-Beam::suspect_slope_b (Real y, Real dy) const
+
+MAKE_SCHEME_CALLBACK (Beam, check_concave, 1);
+SCM
+Beam::check_concave (SCM smob)
{
- /*
- steep slope running against lengthened stem is suspect
- */
- Real first_ideal = first_visible_stem ()->calc_stem_info ().idealy_f_;
- Real last_ideal = last_visible_stem ()->calc_stem_info ().idealy_f_;
- Real lengthened = paper_l ()->get_var ("beam_lengthened");
- Real steep = paper_l ()->get_var ("beam_steep_slope");
+ Grob *me = unsmob_grob (smob);
- Real dx = last_visible_stem ()->hpos_f () - first_visible_stem ()->hpos_f ();
- Real dydx = dy/dx;
+ Link_array<Grob> stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
- if (((y - first_ideal > lengthened) && (dydx > steep))
- || ((y + dy - last_ideal > lengthened) && (dydx < -steep)))
+ for (int i = 0; i < stems.size ();)
{
- return true;
+ if (Stem::invisible_b (stems[i]))
+ stems.del (i);
+ else
+ i++;
}
- return false;
-}
+
+ if (stems.size () < 3)
+ return SCM_UNSPECIFIED;
-/*
- This neat trick is by Werner Lemberg,
- damped = tanh (slope)
- corresponds with some tables in [Wanske]
-*/
-Real
-Beam::calc_slope_damping_f (Real dy) const
-{
- SCM damp = get_elt_property ("damping"); // remove?
- int damping = 1; // ugh.
- if (gh_number_p (damp))
- damping = gh_scm2int (damp);
- if (damping)
+ /* 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 dx = last_visible_stem ()->hpos_f ()
- - first_visible_stem ()->hpos_f ();
- Real dydx = dy/dx;
- dydx = 0.6 * tanh (dydx) / damping;
- return dydx * dx;
+ Real r1 = gh_scm2double (gap);
+ Real dy = Stem::chord_start_y (stems.top ())
+ - Stem::chord_start_y (stems[0]);
+
+
+ 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;
+ }
+ }
}
- return dy;
-}
-Real
-Beam::calc_stem_y_f (Stem* s, Real y, Real dy) const
-{
- Real beam_f = gh_scm2double (get_elt_property ("beam-thickness"));
- int multiplicity = get_multiplicity ();
+
+ /* 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.
- Real interbeam_f = paper_l ()->interbeam_f (multiplicity);
- Real x0 = first_visible_stem ()->hpos_f ();
- Real dx = last_visible_stem ()->hpos_f () - x0;
- Real stem_y = (s->hpos_f () - x0) / dx * dy + y;
- /* knee */
- if (get_direction () != s->get_direction ())
+ Note that "convex" stems compensate for "concave" stems.
+ (is that intentional?) --hwn.
+ */
+
+ 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]))
{
- stem_y -= get_direction () * (beam_f / 2
- + (multiplicity - 1) * interbeam_f);
+ r2 = gh_scm2double (thresh);
- Staff_symbol_referencer_interface me (s);
- Staff_symbol_referencer_interface last (last_visible_stem ());
+ 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 ((s != first_visible_stem ())
- && me.staff_symbol_l () != last.staff_symbol_l ())
- stem_y += get_direction ()
- * (multiplicity - (s->flag_i () - 2) >? 0) * interbeam_f;
- }
- return stem_y;
-}
+ 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);
+
+ /*
-Real
-Beam::check_stem_length_f (Real y, Real dy) const
-{
- Real shorten = 0;
- Real lengthen = 0;
- for (int i=0; i < stem_count (); i++)
- {
- Stem* s = stem (i);
- if (s->invisible_b ())
- continue;
+ ugh: this is the a kludge to get
+ input/regression/beam-concave.ly to behave as
+ baerenreiter.
- Real stem_y = calc_stem_y_f (s, y, dy);
-
- stem_y *= get_direction ();
- Stem_info info = s->calc_stem_info ();
+ */
- if (stem_y > info.maxy_f_)
- shorten = shorten <? info.maxy_f_ - stem_y;
+ /*
+ 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??
- if (stem_y < info.miny_f_)
- lengthen = lengthen >? info.miny_f_ - stem_y;
+ --hwn.
+
+ */
+ concaveness2 /= (stems.size () - 2);
}
+
+ /* TODO: some sort of damping iso -> plain horizontal */
+ if (concaveness1 || concaveness2 > r2)
+ {
+ Drul_array<Real> pos = ly_scm2interval (me->get_grob_property ("positions"));
+ Real r = linear_combination (pos, 0);
- if (lengthen && shorten)
- warning (_ ("weird beam vertical offset"));
+ r /= Staff_symbol_referencer::staff_space (me);
+ me->set_grob_property ("positions", ly_interval2scm (Drul_array<Real> (r, r)));
+ me->set_grob_property ("least-squares-dy", gh_double2scm (0));
+ }
- /* when all stems are too short, normal stems win */
- if (shorten)
- return shorten * get_direction ();
- else
- return lengthen * get_direction ();
+ return SCM_UNSPECIFIED;
}
-void
-Beam::set_stem_length (Real y, Real dy)
+/* This neat trick is by Werner Lemberg,
+ damped = tanh (slope)
+ corresponds with some tables in [Wanske] CHECKME */
+MAKE_SCHEME_CALLBACK (Beam, slope_damping, 1);
+SCM
+Beam::slope_damping (SCM smob)
{
- Real internote_f = paper_l ()->get_var ("interline") / 2;
- for (int i=0; i < stem_count (); i++)
- {
- Stem* s = stem (i);
- if (s->invisible_b ())
- continue;
+ Grob *me = unsmob_grob (smob);
- Real stem_y = calc_stem_y_f (s, y, dy);
+ if (visible_stem_count (me) <= 1)
+ return SCM_UNSPECIFIED;
- /* caution: stem measures in staff-positions */
- s->set_stemend ((stem_y - calc_interstaff_dist (s, this)) / internote_f);
- }
-}
+ SCM s = me->get_grob_property ("damping");
+ int damping = gh_scm2int (s);
-/*
- [Ross] (simplification of)
- Try to set dy complying with:
- - zero
- - beam_f / 2 + staffline_f / 2
- - beam_f + staffline_f
- + n * interline
-
- TODO: get allowed-positions as scm list (aarg: from paper block)
-*/
-Real
-Beam::quantise_dy_f (Real dy) const
-{
- SCM s = get_elt_property ("slope-quantisation");
-
- if (s == ly_symbol2scm ("none"))
- return dy;
+ if (damping)
+ {
+ Drul_array<Real> pos = ly_scm2interval (me->get_grob_property ("positions"));
+ scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
+
+ Real dy = pos[RIGHT] - pos[LEFT];
- Staff_symbol_referencer_interface st (this);
- Real interline_f = st.staff_space ();
-
- Real staffline_f = paper_l ()->get_var ("stafflinethickness");
- Real beam_f = gh_scm2double (get_elt_property ("beam-thickness"));;
+ Grob *fvs = first_visible_stem (me);
+ Grob *lvs = last_visible_stem (me);
- Array<Real> allowed_fraction (3);
- allowed_fraction[0] = 0;
- allowed_fraction[1] = (beam_f / 2 + staffline_f / 2);
- allowed_fraction[2] = (beam_f + staffline_f);
+ Grob *commonx = fvs->common_refpoint (lvs, X_AXIS);
- allowed_fraction.push (interline_f);
- Interval iv = quantise_iv (allowed_fraction, abs (dy));
- Real q = (abs (dy) - iv[SMALLER] <= iv[BIGGER] - abs (dy))
- ? iv[SMALLER]
- : iv[BIGGER];
- return q * sign (dy);
+ Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
+ - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
+ Real dydx = dy && dx ? dy/dx : 0;
+ dydx = 0.6 * tanh (dydx) / damping;
+
+ Real damped_dy = dydx * dx;
+ pos[LEFT] += (dy - damped_dy) / 2;
+ pos[RIGHT] -= (dy - damped_dy) / 2;
+
+ scale_drul (&pos, 1/Staff_symbol_referencer::staff_space (me));
+
+ me->set_grob_property ("positions", ly_interval2scm (pos));
+ }
+ return SCM_UNSPECIFIED;
}
/*
- Prevent interference from stafflines and beams.
- See Documentation/tex/fonts.doc
-
- TODO: get allowed-positions as scm list (aarg: from paper block)
+ Report slice containing the numbers that are both in (car BEAMING)
+ and (cdr BEAMING)
*/
-Real
-Beam::quantise_y_f (Real y, Real dy, int quant_dir)
+Slice
+where_are_the_whole_beams(SCM beaming)
{
- /*
- We only need to quantise the (left) y-position of the beam,
- since dy is quantised too.
- if extend_b then stems must *not* get shorter
- */
- SCM s = get_elt_property ("slope-quantisation");
- if (s == ly_symbol2scm ("none"))
- return y;
-
- /*
- ----------------------------------------------------------
- ########
- ########
- ########
- --------------########------------------------------------
- ########
-
- hang straddle sit inter hang
- */
-
- Staff_symbol_referencer_interface sinf (this);
- Real space = sinf.staff_space ();
- Real staffline_f = paper_l ()->get_var ("stafflinethickness");
- Real beam_f = gh_scm2double (get_elt_property ("beam-thickness"));;
-
- Real straddle = 0;
- Real sit = beam_f / 2 - staffline_f / 2;
- Real hang = space - beam_f / 2 + staffline_f / 2;
-
- /*
- Put all allowed positions into an array.
- Whether a position is allowed or not depends on
- strictness of quantisation, multiplicity and direction.
-
- For simplicity, we'll assume dir = UP and correct if
- dir = DOWN afterwards.
- */
+ Slice l;
- int multiplicity = get_multiplicity ();
-
-
- Array<Real> allowed_position;
- if (s == ly_symbol2scm ("normal"))
- {
- if ((multiplicity <= 2) || (abs (dy) >= staffline_f / 2))
- allowed_position.push (straddle);
- if ((multiplicity <= 1) || (abs (dy) >= staffline_f / 2))
- allowed_position.push (sit);
- allowed_position.push (hang);
- }
- else if (s == ly_symbol2scm ("traditional"))
+ for( SCM s = gh_car (beaming); gh_pair_p (s) ; s = gh_cdr (s))
{
- // TODO: check and fix TRADITIONAL
- if ((multiplicity <= 2) || (abs (dy) >= staffline_f / 2))
- allowed_position.push (straddle);
- if ((multiplicity <= 1) && (dy <= staffline_f / 2))
- allowed_position.push (sit);
- if (dy >= -staffline_f / 2)
- allowed_position.push (hang);
+ if (scm_memq (gh_car (s), gh_cdr (beaming)) != SCM_BOOL_F)
+
+ l.add_point (gh_scm2int (gh_car (s)));
}
- allowed_position.push (space);
- Real up_y = get_direction () * y;
- Interval iv = quantise_iv (allowed_position, up_y);
-
- Real q = up_y - iv[SMALLER] <= iv[BIGGER] - up_y
- ? iv[SMALLER] : iv[BIGGER];
- if (quant_dir)
- q = iv[(Direction)quant_dir];
-
- return q * get_direction ();
+ return l;
}
-void
-Beam::set_beaming (Beaming_info_list *beaming)
+/* Return the Y position of the stem-end, given the Y-left, Y-right
+ in POS for stem S. This Y position is relative to S. */
+Real
+Beam::calc_stem_y (Grob *me, Grob* s, Grob ** common,
+ Real xl, Real xr,
+ Drul_array<Real> pos, bool french)
{
- Direction d = LEFT;
- for (int i=0; i < stem_count (); i++)
+ Real beam_translation = get_beam_translation (me);
+
+
+ Real r = s->relative_coordinate (common[X_AXIS], X_AXIS) - xl;
+ Real dy = pos[RIGHT] - pos[LEFT];
+ Real dx = xr - xl;
+ Real stem_y_beam0 = (dy && dx
+ ? r / dx
+ * dy
+ : 0) + pos[LEFT];
+
+ Direction my_dir = get_grob_direction (s);
+ SCM beaming = s->get_grob_property ("beaming");
+
+ Real stem_y = stem_y_beam0;
+ if (french)
{
- do
- {
- if (stem (i)->beam_count (d) == 0)
- stem (i)->set_beaming ( beaming->infos_.elem (i).beams_i_drul_[d],d);
- }
- while (flip (&d) != LEFT);
+ Slice bm = where_are_the_whole_beams (beaming);
+ if (!bm.is_empty ())
+ stem_y += beam_translation * bm[-my_dir];
+ }
+ else
+ {
+ Slice bm = Stem::beam_multiplicity(s);
+ if (!bm.is_empty ())
+ stem_y +=bm[my_dir] * beam_translation;
}
+
+ Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
+ - s->relative_coordinate (common[Y_AXIS], Y_AXIS);
+
+ return stem_y + id;
}
-
-
/*
- beams to go with one stem.
-
- BURP
- clean me up.
- */
-Molecule
-Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
+ Hmm. At this time, beam position and slope are determined. Maybe,
+ stem directions and length should set to relative to the chord's
+ position of the beam. */
+void
+Beam::set_stem_lengths (Grob *me)
{
- if ((next && !(next->hpos_f () > here->hpos_f ())) ||
- (prev && !(prev->hpos_f () < here->hpos_f ())))
- programming_error ("Beams are not left-to-right");
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
- Real staffline_f = paper_l ()->get_var ("stafflinethickness");
- int multiplicity = get_multiplicity ();
-
-
- Real interbeam_f = paper_l ()->interbeam_f (multiplicity);
- Real beam_f = gh_scm2double (get_elt_property ("beam-thickness"));;
-
- Real dy = interbeam_f;
- Real stemdx = staffline_f;
-
- Real dx = last_visible_stem ()->hpos_f () - first_visible_stem ()->hpos_f ();
- Real dydx = get_real ("height")/dx;
-
- Molecule leftbeams;
- Molecule rightbeams;
-
- // UGH
- Real nw_f;
- if (!here->first_head ())
- nw_f = 0;
- else if (here->type_i ()== 1)
- nw_f = paper_l ()->get_var ("wholewidth");
- else if (here->type_i () == 2)
- nw_f = paper_l ()->get_var ("notewidth") * 0.8;
- else
- nw_f = paper_l ()->get_var ("quartwidth");
-
- /* half beams extending to the left. */
- if (prev)
+ if (!stems.size ())
+ return;
+
+ Grob *common[2];
+ for (int a = 2; a--;)
+ common[a] = common_refpoint_of_array (stems, me, Axis(a));
+
+ Drul_array<Real> pos = ly_scm2realdrul (me->get_grob_property ("positions"));
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ scale_drul (&pos, staff_space);
+
+ bool gap = false;
+ Real thick =0.0;
+ if (gh_number_p (me->get_grob_property ("gap-count"))
+ &&gh_scm2int (me->get_grob_property ("gap-count")))
{
- int lhalfs= lhalfs = here->beam_count (LEFT) - prev->beam_count (RIGHT);
- int lwholebeams= here->beam_count (LEFT) <? prev->beam_count (RIGHT) ;
- /*
- Half beam should be one note-width,
- but let's make sure two half-beams never touch
- */
- Real w = here->hpos_f () - prev->hpos_f ();
- w = w/2 <? nw_f;
- Molecule a;
- if (lhalfs) // generates warnings if not
- a = lookup_l ()->beam (dydx, w, beam_f);
- a.translate (Offset (-w, -w * dydx));
- for (int j = 0; j < lhalfs; j++)
- {
- Molecule b (a);
- b.translate_axis (-get_direction () * dy * (lwholebeams+j), Y_AXIS);
- leftbeams.add_molecule (b);
- }
+ gap = true;
+ thick = get_thickness(me);
}
-
- if (next)
+
+ // ugh -> use commonx
+ Grob * fvs = first_visible_stem (me);
+ Grob *lvs = last_visible_stem (me);
+
+ Real xl = fvs ? fvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
+ Real xr = lvs ? lvs->relative_coordinate (common[X_AXIS], X_AXIS) : 0.0;
+
+ for (int i=0; i < stems.size (); i++)
{
- int rhalfs = here->beam_count (RIGHT) - next->beam_count (LEFT);
- int rwholebeams= here->beam_count (RIGHT) <? next->beam_count (LEFT) ;
-
- Real w = next->hpos_f () - here->hpos_f ();
- Molecule a = lookup_l ()->beam (dydx, w + stemdx, beam_f);
- a.translate_axis( - stemdx/2, X_AXIS);
- int j = 0;
- Real gap_f = 0;
-
- SCM gap = get_elt_property ("beam-gap");
- if (gh_number_p (gap))
- {
- int gap_i = gh_scm2int ( (gap));
- int nogap = rwholebeams - gap_i;
-
- for (; j < nogap; j++)
- {
- Molecule b (a);
- b.translate_axis (-get_direction () * dy * j, Y_AXIS);
- rightbeams.add_molecule (b);
- }
- // TODO: notehead widths differ for different types
- gap_f = nw_f / 2;
- w -= 2 * gap_f;
- a = lookup_l ()->beam (dydx, w + stemdx, beam_f);
- }
-
- for (; j < rwholebeams; j++)
- {
- Molecule b (a);
- if (!here->invisible_b ())
- b.translate (Offset (gap_f, -get_direction () * dy * j));
- else
- b.translate (Offset (0, -get_direction () * dy * j));
- rightbeams.add_molecule (b);
- }
+ Grob* s = stems[i];
+ if (Stem::invisible_b (s))
+ continue;
- w = w/2 <? nw_f;
- if (rhalfs)
- a = lookup_l ()->beam (dydx, w, beam_f);
+ bool french = to_boolean (s->get_grob_property ("french-beaming"));
+ Real stem_y = calc_stem_y (me, s, common,
+ xl, xr,
+ pos, french && s != lvs && s!= fvs);
- for (; j < rwholebeams + rhalfs; j++)
- {
- Molecule b (a);
- b.translate_axis (-get_direction () * dy * j, Y_AXIS);
- rightbeams.add_molecule (b);
- }
+ /*
+ Make the stems go up to the end of the beam. This doesn't matter
+ for normal beams, but for tremolo beams it looks silly otherwise.
+ */
+ if (gap)
+ stem_y += thick * 0.5 * get_grob_direction (s);
+ Stem::set_stemend (s, 2* stem_y / staff_space);
}
- leftbeams.add_molecule (rightbeams);
-
- /*
- Does beam quanting think of the asymetry of beams?
- Refpoint is on bottom of symbol. (FIXTHAT) --hwn.
- */
- return leftbeams;
}
-
-Molecule*
-Beam::do_brew_molecule_p () const
+void
+Beam::set_beaming (Grob *me, Beaming_info_list *beaming)
{
- Molecule *mol_p = new Molecule;
- if (!stem_count ())
- return mol_p;
+ Link_array<Grob> stems=
+ Pointer_group_interface__extract_grobs (me, (Grob *)0, "stems");
- Real x0 = first_visible_stem ()->hpos_f ();
- Real dx = last_visible_stem ()->hpos_f () - x0;
- Real dydx = get_real ("height")/dx;
- Real y = get_real ("y-position");
- for (int j=0; j <stem_count (); j++)
+ Direction d = LEFT;
+ for (int i=0; i < stems.size (); i++)
{
- Stem *i = stem (j);
- Stem * prev = (j > 0)? stem (j-1) : 0;
- Stem * next = (j < stem_count ()-1) ? stem (j+1) :0;
-
- Molecule sb = stem_beams (i, next, prev);
- Real x = i->hpos_f ()-x0;
- sb.translate (Offset (x, x * dydx + y));
- mol_p->add_molecule (sb);
+ /*
+ Don't overwrite user settings.
+ */
+
+ do
+ {
+ /* Don't set beaming for outside of outer stems */
+ if ((d == LEFT && i == 0)
+ ||(d == RIGHT && i == stems.size () -1))
+ continue;
+
+ Grob *st = stems[i];
+ SCM beaming_prop = st->get_grob_property ("beaming");
+ if (beaming_prop == SCM_EOL ||
+ index_get_cell (beaming_prop, d) == SCM_EOL)
+ {
+ int b = beaming->infos_.elem (i).beams_i_drul_[d];
+ if (i>0
+ && i < stems.size() -1
+ && Stem::invisible_b (st))
+ b = b <? beaming->infos_.elem(i).beams_i_drul_[-d];
+
+ Stem::set_beaming (st, b, d);
+ }
+ }
+ while (flip (&d) != LEFT);
}
- mol_p->translate_axis (x0
- - spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS), X_AXIS);
-
- return mol_p;
}
int
-Beam::forced_stem_count () const
+Beam::forced_stem_count (Grob *me)
{
+ Link_array<Grob>stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
int f = 0;
- for (int i=0; i < stem_count (); i++)
+ for (int i=0; i < stems.size (); i++)
{
- Stem *s = stem (i);
+ Grob *s = stems[i];
- if (s->invisible_b ())
+ if (Stem::invisible_b (s))
continue;
- if (((int)s->chord_start_f ())
- && (s->get_direction () != s->get_default_dir ()))
+ /* I can imagine counting those boundaries as a half forced stem,
+ but let's count them full for now. */
+ if (abs (Stem::chord_start_y (s)) > 0.1
+ && (Stem::get_direction (s) != Stem::get_default_dir (s)))
f++;
}
return f;
-/*
- TODO: Fix this class. This is wildly inefficient.
- And it sux. Yet another array/list 'interface'.
- */
-Stem *
-Beam::stem (int i) const
-{
- return Group_interface__extract_elements ((Beam*) this, (Stem*) 0, "stems")[i];
-}
int
-Beam::stem_count () const
+Beam::visible_stem_count (Grob *me)
{
- Group_interface gi (this, "stems");
- return gi.count ();
+ Link_array<Grob>stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
+ int c = 0;
+ for (int i = stems.size (); i--;)
+ {
+ if (!Stem::invisible_b (stems[i]))
+ c++;
+ }
+ return c;
}
-Stem*
-Beam::stem_top () const
+Grob*
+Beam::first_visible_stem (Grob *me)
{
- SCM s = get_elt_property ("stems");
+ Link_array<Grob>stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
- return gh_pair_p (s) ? dynamic_cast<Stem*> (unsmob_element (gh_car (s))) : 0;
-
- //Group_interface__extract_elements ((Beam*) this, (Stem*) 0, "stems")[stem_count () - 1];
+ for (int i = 0; i < stems.size (); i++)
+ {
+ if (!Stem::invisible_b (stems[i]))
+ return stems[i];
+ }
+ return 0;
}
-/* burp */
-int
-Beam::visible_stem_count () const
+Grob*
+Beam::last_visible_stem (Grob *me)
{
- int c = 0;
- for (int i = 0; i < stem_count (); i++)
+ Link_array<Grob>stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
+ for (int i = stems.size (); i--;)
{
- if (!stem (i)->invisible_b ())
- c++;
+ if (!Stem::invisible_b (stems[i]))
+ return stems[i];
}
- return c;
+ return 0;
+}
+
+
+/*
+ [TODO]
+
+ handle rest under beam (do_post: beams are calculated now)
+ what about combination of collisions and rest under beam.
+
+ Should lookup
+
+ rest -> stem -> beam -> interpolate_y_position ()
+*/
+MAKE_SCHEME_CALLBACK (Beam, rest_collision_callback, 2);
+SCM
+Beam::rest_collision_callback (SCM element_smob, SCM axis)
+{
+ Grob *rest = unsmob_grob (element_smob);
+ Axis a = (Axis) gh_scm2int (axis);
+
+ if (gh_number_p (rest->get_grob_property ("staff-position")))
+ return gh_int2scm (0);
+
+ assert (a == Y_AXIS);
+
+ Grob *st = unsmob_grob (rest->get_grob_property ("stem"));
+ Grob *stem = st;
+ if (!stem)
+ return gh_double2scm (0.0);
+ Grob *beam = unsmob_grob (stem->get_grob_property ("beam"));
+ if (!beam
+ || !Beam::has_interface (beam)
+ || !Beam::visible_stem_count (beam))
+ return gh_double2scm (0.0);
+
+ Drul_array<Real> pos (0, 0);
+ SCM s = beam->get_grob_property ("positions");
+ if (gh_pair_p (s) && gh_number_p (ly_car (s)))
+ pos = ly_scm2interval (s);
+ Real staff_space = Staff_symbol_referencer::staff_space (rest);
+
+ scale_drul (&pos, staff_space);
+
+
+ Real dy = pos[RIGHT] - pos[LEFT];
+
+ // ugh -> use commonx
+ Real x0 = first_visible_stem (beam)->relative_coordinate (0, X_AXIS);
+ Real dx = last_visible_stem (beam)->relative_coordinate (0, X_AXIS) - x0;
+ Real dydx = dy && dx ? dy/dx : 0;
+
+ Direction d = Stem::get_direction (stem);
+ Real stem_y = pos[LEFT] + (stem->relative_coordinate (0, X_AXIS) - x0) * dydx;
+
+ Real beam_translation = get_beam_translation (beam);
+ Real beam_thickness = Beam::get_thickness (beam);
+
+ int beam_count = get_direction_beam_count (beam, d);
+ Real height_of_my_beams = beam_thickness / 2
+ + (beam_count - 1) * beam_translation;
+ Real beam_y = stem_y - d * height_of_my_beams;
+
+ Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
+
+ Real rest_dim = rest->extent (common_y, Y_AXIS)[d];
+ Real minimum_distance =
+ staff_space * robust_scm2double (rest->get_grob_property ("minimum-distance"), 0.0);
+
+ Real shift = d * (((beam_y - d * minimum_distance) - rest_dim) * d <? 0.0);
+
+ shift /= staff_space;
+ Real rad = Staff_symbol_referencer::line_count (rest) * staff_space / 2;
+
+ /* Always move discretely by half spaces */
+ shift = ceil (fabs (shift * 2.0)) / 2.0 * sign (shift);
+
+ /* Inside staff, move by whole spaces*/
+ if ((rest->extent (common_y, Y_AXIS)[d] + staff_space * shift) * d
+ < rad
+ || (rest->extent (common_y, Y_AXIS)[-d] + staff_space * shift) * -d
+ < rad)
+ shift = ceil (fabs (shift)) *sign (shift);
+
+ return gh_double2scm (staff_space * shift);
}
-Stem*
-Beam::first_visible_stem () const
+bool
+Beam::knee_b (Grob* me)
{
- for (int i = 0; i < stem_count (); i++)
+ SCM k = me->get_grob_property ("knee");
+ if (gh_boolean_p (k))
+ return gh_scm2bool (k);
+
+ bool knee = false;
+ int d = 0;
+ for (SCM s = me->get_grob_property ("stems"); gh_pair_p (s); s = ly_cdr (s))
{
- Stem* s = stem (i);
- if (!s->invisible_b ())
- return s;
+ Direction dir = get_grob_direction (unsmob_grob (ly_car (s)));
+ if (d && d != dir)
+ {
+ knee = true;
+ break;
+ }
+ d = dir;
}
+
+ me->set_grob_property ("knee", gh_bool2scm (knee));
- assert (0);
-
- return 0;
+ return knee;
}
-Stem*
-Beam::last_visible_stem () const
+int
+Beam::get_direction_beam_count (Grob *me, Direction d )
{
- for (int i = stem_count (); i > 0; i--)
+ Link_array<Grob>stems =
+ Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
+ int bc = 0;
+
+ for (int i = stems.size (); i--;)
{
- Stem* s = stem (i - 1);
- if (!s->invisible_b ())
- return s;
+ /*
+ Should we take invisible stems into account?
+ */
+ if (Stem::get_direction (stems[i]) == d)
+ bc = bc >? (Stem::beam_multiplicity (stems[i]).length () + 1);
}
- assert (0);
- // sigh
- return 0;
+ return bc;
}
+
+
+ADD_INTERFACE (Beam, "beam-interface",
+ "A beam. \n\n"
+" "
+"#'thickness= weight of beams, in staffspace "
+" "
+" "
+"We take the least squares line through the ideal-length stems, and "
+"then damp that using "
+" \n"
+" damped = tanh (slope) \n"
+" \n"
+"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. "
+,
+ "knee positioning-done position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap gap-count chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");
+
+
projects / lilypond.git / blobdiff