/*
- beam.cc -- implement Beam
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
Jan Nieuwenhuizen <janneke@gnu.org>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
/*
- beam_translation is the offset between Y centers of the beam.
*/
-#include <math.h> // tanh.
-
#include "beam.hh"
-#include "interval-set.hh"
+
+#include "axis-group-interface.hh"
+#include "align-interface.hh"
+#include "beam-scoring-problem.hh"
+#include "beaming-pattern.hh"
#include "directional-element-interface.hh"
-#include "beaming.hh"
+#include "grob-array.hh"
+#include "international.hh"
+#include "interval-set.hh"
+#include "item.hh"
+#include "lookup.hh"
+#include "main.hh"
#include "misc.hh"
-#include "least-squares.hh"
-#include "stem.hh"
+#include "note-head.hh"
#include "output-def.hh"
-#include "lookup.hh"
-#include "group-interface.hh"
-#include "staff-symbol-referencer.hh"
-#include "item.hh"
+#include "pointer-group-interface.hh"
+#include "rhythmic-head.hh"
#include "spanner.hh"
+#include "staff-symbol.hh"
+#include "staff-symbol-referencer.hh"
+#include "stem.hh"
#include "warn.hh"
-#if DEBUG_QUANTING
-#include "text-item.hh" // debug output.
+#if DEBUG_BEAM_SCORING
+#include "text-interface.hh" // debug output.
#include "font-interface.hh" // debug output.
#endif
-void
-Beam::add_stem (Grob *me, Grob *s)
+#include <map>
+
+Beam_stem_segment::Beam_stem_segment ()
{
- Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s);
+ max_connect_ = 1000; // infinity
+ stem_ = 0;
+ width_ = 0.0;
+ stem_x_ = 0.0;
+ rank_ = 0;
+ stem_index_ = 0;
+ dir_ = CENTER;
+}
- s->add_dependency (me);
+bool
+beam_segment_less (Beam_segment const &a, Beam_segment const &b)
+{
+ return a.horizontal_[LEFT] < b.horizontal_[LEFT];
+}
- assert (!Stem::get_beam (s));
- s->set_property ("beam", me->self_scm ());
+Beam_segment::Beam_segment ()
+{
+ vertical_count_ = 0;
+}
+void
+Beam::add_stem (Grob *me, Grob *s)
+{
+ if (Stem::get_beam (s))
+ {
+ programming_error ("Stem already has beam");
+ return;
+ }
+
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s);
+ s->set_object ("beam", me->self_scm ());
add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (s));
}
Real
-Beam::get_thickness (Grob *me)
+Beam::get_beam_thickness (Grob *me)
{
- return robust_scm2double (me->get_property ("thickness"), 0)
- * Staff_symbol_referencer::staff_space (me);
+ return robust_scm2double (me->get_property ("beam-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_property ("space-function");
+ int beam_count = get_beam_count (me);
+ Real staff_space = Staff_symbol_referencer::staff_space (me);
+ Real line = Staff_symbol_referencer::line_thickness (me);
+ Real beam_thickness = get_beam_thickness (me);
+ Real fract = robust_scm2double (me->get_property ("length-fraction"), 1.0);
- if (ly_c_procedure_p (func))
- {
- SCM s = scm_call_2 (func, me->self_scm (), scm_int2num (get_beam_count (me)));
- return scm_to_double (s);
- }
- else
- {
- return 0.81;
- }
+ Real beam_translation = beam_count < 4
+ ? (2 * staff_space + line - beam_thickness) / 2.0
+ : (3 * staff_space + line - beam_thickness) / 3.0;
+
+ return fract * beam_translation;
}
/* Maximum beam_count. */
Beam::get_beam_count (Grob *me)
{
int m = 0;
- for (SCM s = me->get_property ("stems"); scm_is_pair (s); s = scm_cdr (s))
+
+ extract_grob_set (me, "stems", stems);
+ for (vsize i = 0; i < stems.size (); i++)
{
- Grob *stem = unsmob_grob (scm_car (s));
- m = m >? (Stem::beam_multiplicity (stem).length () + 1);
+ Grob *stem = stems[i];
+ m = max (m, (Stem::beam_multiplicity (stem).length () + 1));
}
return m;
}
-/*
- Space return space between beams.
-*/
-MAKE_SCHEME_CALLBACK (Beam, space_function, 2);
+MAKE_SCHEME_CALLBACK (Beam, calc_normal_stems, 1);
SCM
-Beam::space_function (SCM smob, SCM beam_count)
+Beam::calc_normal_stems (SCM smob)
{
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 = scm_to_int (beam_count) < 4
- ? (2*staff_space + line - thickness) / 2.0
- : (3*staff_space + line - thickness) / 3.0;
+ extract_grob_set (me, "stems", stems);
+ SCM val = Grob_array::make_array ();
+ Grob_array *ga = unsmob_grob_array (val);
+ for (vsize i = 0; i < stems.size (); i++)
+ if (Stem::is_normal_stem (stems[i]))
+ ga->add (stems[i]);
- return scm_make_real (beam_translation);
+ return val;
}
-/* 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);
+MAKE_SCHEME_CALLBACK (Beam, calc_direction, 1);
SCM
-Beam::before_line_breaking (SCM smob)
+Beam::calc_direction (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].
+ 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. */
+ Direction dir = CENTER;
- int count = visible_stem_count (me);
+ int count = normal_stem_count (me);
if (count < 2)
{
- me->warning (_ ("beam has less than two visible stems"));
-
- SCM stems = me->get_property ("stems");
- if (scm_ilength (stems) == 1)
- {
- me->warning (_ ("removing beam with less than two stems"));
-
- unsmob_grob (scm_car (stems))->set_property ("beam", SCM_EOL);
- me->suicide ();
-
- return SCM_UNSPECIFIED;
- }
- else if (scm_ilength (stems) == 0)
- {
- me->suicide ();
- return SCM_UNSPECIFIED;
- }
+ extract_grob_set (me, "stems", stems);
+ if (stems.size () == 0)
+ {
+ me->warning (_ ("removing beam with no stems"));
+ me->suicide ();
+
+ return SCM_UNSPECIFIED;
+ }
+ else
+ {
+ Grob *stem = first_normal_stem (me);
+
+ /*
+ This happens for chord tremolos.
+ */
+ if (!stem)
+ stem = stems[0];
+
+ if (is_direction (stem->get_property_data ("direction")))
+ dir = to_dir (stem->get_property_data ("direction"));
+ else
+ dir = to_dir (stem->get_property ("default-direction"));
+
+ extract_grob_set (stem, "note-heads", heads);
+ /* default position of Kievan heads with beams is down
+ placing this here avoids warnings downstream */
+ if (heads.size())
+ {
+ if (heads[0]->get_property ("style") == ly_symbol2scm ("kievan"))
+ {
+ if (dir == CENTER)
+ dir = DOWN;
+ }
+ }
+ }
}
+
if (count >= 1)
{
- Direction d = get_default_dir (me);
+ if (!dir)
+ dir = get_default_dir (me);
consider_auto_knees (me);
- set_stem_directions (me, d);
-
- connect_beams (me);
+ }
- set_stem_shorten (me);
+ if (dir)
+ {
+ set_stem_directions (me, dir);
}
- return SCM_EOL;
+ return scm_from_int (dir);
}
-/*
- 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
-*/
+/* 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)
+ Direction left_dir,
+ Direction right_dir)
{
Slice lslice = int_list_to_slice (scm_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)
+ (i - lslice[left_dir]) * left_dir <= 0; i += left_dir)
{
int count = 0;
for (SCM s = scm_car (right_beaming); scm_is_pair (s); s = scm_cdr (s))
- {
- int k = -right_dir * scm_to_int (scm_car (s)) + i;
- if (scm_c_memq (scm_int2num (k), left_beaming) != SCM_BOOL_F)
- count++;
- }
+ {
+ int k = -right_dir * scm_to_int (scm_car (s)) + i;
+ if (scm_c_memq (scm_from_int (k), left_beaming) != SCM_BOOL_F)
+ count++;
+ }
if (count >= best_count)
- {
- best_count = count;
- best_start = i;
- }
+ {
+ best_count = count;
+ best_start = i;
+ }
}
return best_start;
}
-void
-Beam::connect_beams (Grob *me)
+MAKE_SCHEME_CALLBACK (Beam, calc_beaming, 1)
+SCM
+Beam::calc_beaming (SCM smob)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ Grob *me = unsmob_grob (smob);
+
+ extract_grob_set (me, "stems", stems);
Slice last_int;
last_int.set_empty ();
- SCM last_beaming = SCM_EOL;
+
+ SCM last_beaming = scm_cons (SCM_EOL, scm_list_1 (scm_from_int (0)));
Direction last_dir = CENTER;
- for (int i = 0; i< stems.size (); i++)
+ for (vsize i = 0; i < stems.size (); i++)
{
Grob *this_stem = stems[i];
SCM this_beaming = this_stem->get_property ("beaming");
Direction this_dir = get_grob_direction (this_stem);
if (scm_is_pair (last_beaming) && scm_is_pair (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 (; scm_is_pair (s); s = scm_cdr (s))
- {
- int new_beam_pos
- = start_point - this_dir * scm_to_int (scm_car (s));
-
- new_slice.add_point (new_beam_pos);
- scm_set_car_x (s, scm_int2num (new_beam_pos));
- }
-
- }
- while (flip (&d) != LEFT);
-
- if (!new_slice.is_empty ())
- last_int = new_slice;
- }
+ {
+ int start_point = position_with_maximal_common_beams
+ (last_beaming, this_beaming,
+ last_dir ? last_dir : this_dir,
+ this_dir);
+
+ Slice new_slice;
+ for (LEFT_and_RIGHT (d))
+ {
+ new_slice.set_empty ();
+ SCM s = index_get_cell (this_beaming, d);
+ for (; scm_is_pair (s); s = scm_cdr (s))
+ {
+ int new_beam_pos
+ = start_point - this_dir * scm_to_int (scm_car (s));
+
+ new_slice.add_point (new_beam_pos);
+ scm_set_car_x (s, scm_from_int (new_beam_pos));
+ }
+ }
+
+ if (!new_slice.is_empty ())
+ last_int = new_slice;
+ }
else
- {
- scm_set_car_x (this_beaming, SCM_EOL);
- SCM s = scm_cdr (this_beaming);
- for (; scm_is_pair (s); s = scm_cdr (s))
- {
- int np = -this_dir * scm_to_int (scm_car (s));
- scm_set_car_x (s, scm_int2num (np));
- last_int.add_point (np);
- }
- }
-
- if (i == stems.size () -1)
- {
- scm_set_cdr_x (this_beaming, SCM_EOL);
- }
+ {
+ /*
+ FIXME: what's this for?
+ */
+ SCM s = scm_cdr (this_beaming);
+ for (; scm_is_pair (s); s = scm_cdr (s))
+ {
+ int np = -this_dir * scm_to_int (scm_car (s));
+ scm_set_car_x (s, scm_from_int (np));
+ last_int.add_point (np);
+ }
+ }
if (scm_ilength (scm_cdr (this_beaming)) > 0)
- {
- last_beaming = this_beaming;
- last_dir = this_dir;
- }
+ {
+ last_beaming = this_beaming;
+ last_dir = this_dir;
+ }
}
+
+ return SCM_EOL;
}
-/*
- TODO: should not make beams per stem, but per Y-level.
-*/
-MAKE_SCHEME_CALLBACK (Beam, print, 1);
+bool
+operator <(Beam_stem_segment const &a,
+ Beam_stem_segment const &b)
+{
+ return a.rank_ < b.rank_;
+}
+
+typedef map<int, vector<Beam_stem_segment> > Position_stem_segments_map;
+
+MAKE_SCHEME_CALLBACK (Beam, calc_beam_segments, 1);
SCM
-Beam::print (SCM grob)
+Beam::calc_beam_segments (SCM smob)
{
- Spanner *me = unsmob_spanner (grob);
- position_beam (me);
+ /* ugh, this has a side-effect that we need to ensure that
+ Stem #'beaming is correct */
+ Grob *me_grob = unsmob_grob (smob);
+ (void) me_grob->get_property ("beaming");
+
+ Spanner *me = dynamic_cast<Spanner *> (me_grob);
+
+ extract_grob_set (me, "stems", stems);
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
- Grob *xcommon = common_refpoint_of_array (stems, me, X_AXIS);
+ Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
+ for (LEFT_and_RIGHT (d))
+ commonx = me->get_bound (d)->common_refpoint (commonx, X_AXIS);
- xcommon = me->get_bound (LEFT)->common_refpoint (xcommon, X_AXIS);
- xcommon = me->get_bound (RIGHT)->common_refpoint (xcommon, X_AXIS);
+ int gap_count = robust_scm2int (me->get_property ("gap-count"), 0);
+ Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
- Real x0, dx;
- if (visible_stem_count (me))
+ Position_stem_segments_map stem_segments;
+ Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+
+ /* There are two concepts of "rank" that are used in the following code.
+ The beam_rank is the vertical position of the beam (larger numbers are
+ closer to the noteheads). Beam_stem_segment.rank_, on the other hand,
+ is the horizontal position of the segment (this is incremented by two
+ for each stem; the beam segment on the right side of the stem has
+ a higher rank (by one) than its neighbour to the left). */
+ Slice ranks;
+ for (vsize i = 0; i < stems.size (); i++)
{
- // ugh -> use commonx
- x0 = first_visible_stem (me)->relative_coordinate (xcommon, X_AXIS);
- dx = last_visible_stem (me)->relative_coordinate (xcommon, X_AXIS) - x0;
+ Grob *stem = stems[i];
+ Real stem_width = robust_scm2double (stem->get_property ("thickness"), 1.0) * lt;
+ Real stem_x = stem->relative_coordinate (commonx, X_AXIS);
+ SCM beaming = stem->get_property ("beaming");
+
+ for (LEFT_and_RIGHT (d))
+ {
+ // Find the maximum and minimum beam ranks.
+ // Given that RANKS is never reset to empty, the interval will always be
+ // smallest for the left beamlet of the first stem, and then it might grow.
+ // Do we really want this? (It only affects the tremolo gaps) --jneem
+ for (SCM s = index_get_cell (beaming, d);
+ scm_is_pair (s); s = scm_cdr (s))
+ {
+ if (!scm_is_integer (scm_car (s)))
+ continue;
+
+ int beam_rank = scm_to_int (scm_car (s));
+ ranks.add_point (beam_rank);
+ }
+
+ for (SCM s = index_get_cell (beaming, d);
+ scm_is_pair (s); s = scm_cdr (s))
+ {
+ if (!scm_is_integer (scm_car (s)))
+ continue;
+
+ int beam_rank = scm_to_int (scm_car (s));
+ Beam_stem_segment seg;
+ seg.stem_ = stem;
+ seg.stem_x_ = stem_x;
+ seg.rank_ = 2 * i + (d + 1) / 2;
+ seg.width_ = stem_width;
+ seg.stem_index_ = i;
+ seg.dir_ = d;
+ seg.max_connect_ = robust_scm2int (stem->get_property ("max-beam-connect"), 1000);
+
+ Direction stem_dir = get_grob_direction (stem);
+
+ seg.gapped_
+ = (stem_dir * beam_rank < (stem_dir * ranks[-stem_dir] + gap_count));
+ stem_segments[beam_rank].push_back (seg);
+ }
+ }
}
- else
+
+ Drul_array<Real> break_overshoot
+ = robust_scm2drul (me->get_property ("break-overshoot"),
+ Drul_array<Real> (-0.5, 0.0));
+
+ vector<Beam_segment> segments;
+ for (Position_stem_segments_map::const_iterator i (stem_segments.begin ());
+ i != stem_segments.end (); i++)
{
- x0 = stems[0]->relative_coordinate (xcommon, X_AXIS);
- dx = stems.top ()->relative_coordinate (xcommon, X_AXIS) - x0;
+ vector<Beam_stem_segment> segs = (*i).second;
+ vector_sort (segs, less<Beam_stem_segment> ());
+
+ Beam_segment current;
+
+ // Iterate over all of the segments of the current beam rank,
+ // merging the adjacent Beam_stem_segments into one Beam_segment
+ // when appropriate.
+ int vertical_count = (*i).first;
+ for (vsize j = 0; j < segs.size (); j++)
+ {
+ // Keeping track of the different directions here is a little tricky.
+ // segs[j].dir_ is the direction of the beam segment relative to the stem
+ // (ie. segs[j].dir_ == LEFT if the beam segment sticks out to the left of
+ // its stem) whereas event_dir refers to the edge of the beam segment that
+ // we are currently looking at (ie. if segs[j].dir_ == event_dir then we
+ // are looking at that edge of the beam segment that is furthest from its
+ // stem).
+ Beam_stem_segment const &seg = segs[j];
+ for (LEFT_and_RIGHT (event_dir))
+ {
+ Beam_stem_segment const &neighbor_seg = segs[j + event_dir];
+ // TODO: make names clearer? --jneem
+ // on_line_bound: whether the current segment is on the boundary of the WHOLE beam
+ // on_beam_bound: whether the current segment is on the boundary of just that part
+ // of the beam with the current beam_rank
+ bool on_line_bound = (seg.dir_ == LEFT) ? seg.stem_index_ == 0
+ : seg.stem_index_ == stems.size () - 1;
+ bool on_beam_bound = (event_dir == LEFT) ? j == 0
+ : j == segs.size () - 1;
+ bool inside_stem = (event_dir == LEFT)
+ ? seg.stem_index_ > 0
+ : seg.stem_index_ + 1 < stems.size ();
+
+ bool event = on_beam_bound
+ || abs (seg.rank_ - neighbor_seg.rank_) > 1
+ || (abs (vertical_count) >= seg.max_connect_
+ || abs (vertical_count) >= neighbor_seg.max_connect_);
+
+ if (!event)
+ // Then this edge of the current segment is irrelevant because it will
+ // be connected with the next segment in the event_dir direction.
+ // If we skip the left edge here, the right edge of
+ // the previous segment has already been skipped since
+ // the conditions are symmetric
+ continue;
+
+ current.vertical_count_ = vertical_count;
+ current.horizontal_[event_dir] = seg.stem_x_;
+ if (seg.dir_ == event_dir)
+ // then we are examining the edge of a beam segment that is furthest
+ // from its stem.
+ {
+ if (on_line_bound
+ && me->get_bound (event_dir)->break_status_dir ())
+ {
+ current.horizontal_[event_dir]
+ = (Axis_group_interface::generic_bound_extent (me->get_bound (event_dir),
+ commonx, X_AXIS)[RIGHT]
+ + event_dir * break_overshoot[event_dir]);
+ }
+ else
+ {
+ Grob *stem = stems[seg.stem_index_];
+ Drul_array<Real> beamlet_length
+ = robust_scm2interval (stem->get_property ("beamlet-default-length"), Interval (1.1, 1.1));
+ Drul_array<Real> max_proportion
+ = robust_scm2interval (stem->get_property ("beamlet-max-length-proportion"), Interval (0.75, 0.75));
+ Real length = beamlet_length[seg.dir_];
+
+ if (inside_stem)
+ {
+ Grob *neighbor_stem = stems[seg.stem_index_ + event_dir];
+ Real neighbor_stem_x = neighbor_stem->relative_coordinate (commonx, X_AXIS);
+
+ length = min (length,
+ fabs (neighbor_stem_x - seg.stem_x_) * max_proportion[seg.dir_]);
+ }
+ current.horizontal_[event_dir] += event_dir * length;
+ }
+ }
+ else
+ // we are examining the edge of a beam segment that is closest
+ // (ie. touching, unless there is a gap) its stem.
+ {
+ current.horizontal_[event_dir] += event_dir * seg.width_ / 2;
+ if (seg.gapped_)
+ {
+ current.horizontal_[event_dir] -= event_dir * gap_length;
+
+ if (Stem::is_invisible (seg.stem_))
+ {
+ /*
+ Need to do this in case of whole notes. We don't want the
+ heads to collide with the beams.
+ */
+ extract_grob_set (seg.stem_, "note-heads", heads);
+
+ for (vsize k = 0; k < heads.size (); k++)
+ current.horizontal_[event_dir]
+ = event_dir * min (event_dir * current.horizontal_[event_dir],
+ - gap_length / 2
+ + event_dir
+ * heads[k]->extent (commonx,
+ X_AXIS)[-event_dir]);
+ }
+ }
+ }
+
+ if (event_dir == RIGHT)
+ {
+ segments.push_back (current);
+ current = Beam_segment ();
+ }
+ }
+ }
+
}
- SCM posns = me->get_property ("positions");
- Drul_array<Real> pos;
+ SCM segments_scm = SCM_EOL;
+
+ for (vsize i = segments.size (); i--;)
+ {
+ segments_scm = scm_cons (scm_list_2 (scm_cons (ly_symbol2scm ("vertical-count"),
+ scm_from_int (segments[i].vertical_count_)),
+ scm_cons (ly_symbol2scm ("horizontal"),
+ ly_interval2scm (segments[i].horizontal_))),
+ segments_scm);
+ }
+
+ return segments_scm;
+}
+
+MAKE_SCHEME_CALLBACK (Beam, calc_x_positions, 1);
+SCM
+Beam::calc_x_positions (SCM smob)
+{
+ Spanner *me = unsmob_spanner (smob);
+ SCM segments = me->get_property ("beam-segments");
+ Interval x_positions;
+ x_positions.set_empty ();
+ for (SCM s = segments; scm_is_pair (s); s = scm_cdr (s))
+ x_positions.unite (robust_scm2interval (ly_assoc_get (ly_symbol2scm ("horizontal"),
+ scm_car (s),
+ SCM_EOL),
+ Interval (0.0, 0.0)));
+
+ // Case for beams without segments (i.e. uniting two skips with a beam)
+ // TODO: should issue a warning? warning likely issued downstream, but couldn't hurt...
+ if (x_positions.is_empty ())
+ {
+ extract_grob_set (me, "stems", stems);
+ Grob *common_x = common_refpoint_of_array (stems, me, X_AXIS);
+ for (LEFT_and_RIGHT (d))
+ x_positions[d] = me->relative_coordinate (common_x, X_AXIS);
+ }
+ return ly_interval2scm (x_positions);
+}
+
+vector<Beam_segment>
+Beam::get_beam_segments (Grob *me)
+{
+ SCM segments_scm = me->get_property ("beam-segments");
+ vector<Beam_segment> segments;
+ for (SCM s = segments_scm; scm_is_pair (s); s = scm_cdr (s))
+ {
+ segments.push_back (Beam_segment ());
+ segments.back ().vertical_count_ = robust_scm2int (ly_assoc_get (ly_symbol2scm ("vertical-count"), scm_car (s), SCM_EOL), 0);
+ segments.back ().horizontal_ = robust_scm2interval (ly_assoc_get (ly_symbol2scm ("horizontal"), scm_car (s), SCM_EOL), Interval (0.0, 0.0));
+ }
+
+ return segments;
+}
+
+MAKE_SCHEME_CALLBACK (Beam, print, 1);
+SCM
+Beam::print (SCM grob)
+{
+ Spanner *me = unsmob_spanner (grob);
+ /*
+ TODO - mild code dup for all the commonx calls.
+ Some use just common_refpoint_of_array, some (in print and
+ calc_beam_segments) use this plus calls to get_bound.
+
+ Figure out if there is any particular reason for this and
+ consolidate in one Beam::get_common function.
+ */
+ extract_grob_set (me, "stems", stems);
+ Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
+ for (LEFT_and_RIGHT (d))
+ commonx = me->get_bound (d)->common_refpoint (commonx, X_AXIS);
+
+ vector<Beam_segment> segments = get_beam_segments (me);
+
+ if (!segments.size ())
+ return SCM_EOL;
+
+ Real blot = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+
+ SCM posns = me->get_property ("quantized-positions");
+ Interval span = robust_scm2interval (me->get_property ("X-positions"), Interval (0, 0));
+ Interval pos;
if (!is_number_pair (posns))
{
- programming_error ("No beam posns");
+ programming_error ("no beam positions?");
pos = Interval (0, 0);
}
else
scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
Real dy = pos[RIGHT] - pos[LEFT];
- Real slope = (dy && dx) ? dy / dx : 0;
+ Real slope = (dy && span.length ()) ? dy / span.length () : 0;
- Real thick = get_thickness (me);
- Real bdy = get_beam_translation (me);
+ Real beam_thickness = get_beam_thickness (me);
+ Real beam_dy = get_beam_translation (me);
- SCM last_beaming = SCM_EOL;
- Real last_xposn = -1;
- Real last_stem_width = -1;
+ Direction feather_dir = to_dir (me->get_property ("grow-direction"));
- Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
+ Interval placements = robust_scm2interval (me->get_property ("normalized-endpoints"), Interval (0.0, 0.0));
Stencil the_beam;
- Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
+ vsize extreme = (segments[0].vertical_count_ == 0
+ ? segments[0].vertical_count_
+ : segments.back ().vertical_count_);
- for (int i = 0; i<= stems.size (); i++)
+ for (vsize i = 0; i < segments.size (); i++)
{
- Grob *st = (i < stems.size ()) ? stems[i] : 0;
-
- SCM this_beaming = st ? st->get_property ("beaming") : SCM_EOL;
- Real xposn = st ? st->relative_coordinate (xcommon, X_AXIS) : 0.0;
- Real stem_width = st ? robust_scm2double (st->get_property ("thickness"), 1.0) *lt : 0;
- Direction stem_dir = st ? to_dir (st->get_property ("direction")) : CENTER;
+ Real local_slope = slope;
/*
- We do the space left of ST, with lfliebertjes pointing to the
- right from the left stem, and rfliebertjes pointing left from
- right stem.
+ Makes local slope proportional to the ratio of the length of this beam
+ to the total length.
*/
- SCM left = (i > 0) ? scm_cdr (last_beaming) : SCM_EOL;
- SCM right = st ? scm_car (this_beaming) : SCM_EOL;
-
- Array<int> full_beams;
- Array<int> lfliebertjes;
- Array<int> rfliebertjes;
-
- for (SCM s = left;
- scm_is_pair (s); s = scm_cdr (s))
- {
- int b = scm_to_int (scm_car (s));
- if (scm_c_memq (scm_car (s), right) != SCM_BOOL_F)
- {
- full_beams.push (b);
- }
- else
- {
- lfliebertjes.push (b);
- }
- }
- for (SCM s = right;
- scm_is_pair (s); s = scm_cdr (s))
- {
- int b = scm_to_int (scm_car (s));
- if (scm_c_memq (scm_car (s), left) == SCM_BOOL_F)
- {
- rfliebertjes.push (b);
- }
- }
+ if (feather_dir)
+ local_slope += (feather_dir * segments[i].vertical_count_
+ * beam_dy
+ * placements.length ()
+ / span.length ());
+
+ Stencil b = Lookup::beam (local_slope, segments[i].horizontal_.length (), beam_thickness, blot);
+
+ b.translate_axis (segments[i].horizontal_[LEFT], X_AXIS);
+ Real multiplier = feather_dir ? placements[LEFT] : 1.0;
+
+ Interval weights (1 - multiplier, multiplier);
+
+ if (feather_dir != LEFT)
+ weights.swap ();
+
+ // we need two translations: the normal one and
+ // the one of the lowest segment
+ size_t idx[] = {i, extreme};
+ Real translations[2];
+
+ for (int j = 0; j < 2; j++)
+ translations[j] = slope
+ * (segments[idx[j]].horizontal_[LEFT] - span.linear_combination (CENTER))
+ + pos.linear_combination (CENTER)
+ + beam_dy * segments[idx[j]].vertical_count_;
+
+ Real weighted_average = translations[0] * weights[LEFT] + translations[1] * weights[RIGHT];
/*
- how much to stick out for beams across linebreaks
+ Tricky. The manipulation of the variable `weighted_average' below ensures
+ that beams with a RIGHT grow direction will start from the position of the
+ lowest segment at 0, and this error will decrease and decrease over the
+ course of the beam. Something with a LEFT grow direction, on the other
+ hand, will always start in the correct place but progressively accrue
+ error at broken places. This code shifts beams up given where they are
+ in the total span length (controlled by the variable `multiplier'). To
+ better understand what it does, try commenting it out: you'll see that
+ all of the RIGHT growing beams immediately start too low and get better
+ over line breaks, whereas all of the LEFT growing beams start just right
+ and get worse over line breaks.
*/
- 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_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
- Stencil whole = Lookup::beam (slope, w, thick, blot);
- Stencil gapped;
-
- int gap_count = 0;
- if (scm_is_number (me->get_property ("gap-count")))
- {
- gap_count = scm_to_int (me->get_property ("gap-count"));
- gapped = Lookup::beam (slope, 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--;)
- {
- Stencil 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 (slope * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
-
- the_beam.add_stencil (b);
- }
-
- if (lfliebertjes.size () || rfliebertjes.size ())
- {
- Real nw_f;
-
- if (st)
- {
- int t = Stem::duration_log (st);
-
- SCM proc = me->get_property ("flag-width-function");
- SCM result = scm_call_1 (proc, scm_int2num (t));
- nw_f = scm_to_double (result);
- }
- else
- nw_f = break_overshoot / 2;
-
- /* Half beam should be one note-width,
- but let's make sure two half-beams never touch */
- Real lw = nw_f;
- Real rw = nw_f;
- if (i > 0)
- rw = nw_f <? ((xposn - last_xposn) / 2);
- else
- /*
- TODO: 0.5 is a guess.
- */
- rw = xposn - me->get_bound (LEFT)->extent (xcommon, X_AXIS)[RIGHT]
- - 0.5;
-
- if (st)
- lw = nw_f <? ((xposn - last_xposn) / 2);
- else
- lw = me->get_bound (RIGHT)->relative_coordinate (xcommon, X_AXIS)
- - last_xposn;
-
- Stencil rhalf = Lookup::beam (slope, rw, thick, blot);
- Stencil lhalf = Lookup::beam (slope, lw, thick, blot);
- for (int j = lfliebertjes.size (); j--;)
- {
- Stencil b (lhalf);
- b.translate_axis (last_xposn - x0, X_AXIS);
- b.translate_axis (slope * (last_xposn - x0) + bdy * lfliebertjes[j], Y_AXIS);
- the_beam.add_stencil (b);
- }
- for (int j = rfliebertjes.size (); j--;)
- {
- Stencil b (rhalf);
- b.translate_axis (xposn - x0 - rw, X_AXIS);
- b.translate_axis (slope * (xposn - x0 -rw) + bdy * rfliebertjes[j], Y_AXIS);
- the_beam.add_stencil (b);
- }
- }
-
- last_xposn = xposn;
- last_stem_width = stem_width;
- last_beaming = this_beaming;
- }
+ Real factor = Interval (multiplier, 1 - multiplier).linear_combination (feather_dir);
+
+ if (segments[0].vertical_count_ < 0 && feather_dir)
+ weighted_average += beam_dy * (segments.size () - 1) * factor;
- the_beam.translate_axis (x0 - me->relative_coordinate (xcommon, X_AXIS), X_AXIS);
- the_beam.translate_axis (pos[LEFT], Y_AXIS);
+ b.translate_axis (weighted_average, Y_AXIS);
-#if (DEBUG_QUANTING)
- SCM quant_score = me->get_property ("quant-score");
- if (to_boolean (me->get_layout ()->lookup_variable (ly_symbol2scm ("debug-beam-quanting")))
- && scm_is_string (quant_score))
+ the_beam.add_stencil (b);
+
+ }
+
+#if (DEBUG_BEAM_SCORING)
+ SCM annotation = me->get_property ("annotation");
+ if (scm_is_string (annotation))
{
+ extract_grob_set (me, "stems", stems);
/*
- This code prints the demerits for each beam. Perhaps this
- should be switchable for those who want to twiddle with the
- parameters.
+ This code prints the demerits for each beam. Perhaps this
+ should be switchable for those who want to twiddle with the
+ parameters.
*/
- String str;
+ string str;
SCM properties = Font_interface::text_font_alist_chain (me);
+ properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-5), SCM_EOL),
+ properties);
+
Direction stem_dir = stems.size () ? to_dir (stems[0]->get_property ("direction")) : UP;
- Stencil tm = *unsmob_stencil (Text_interface::interpret_markup
- (me->get_layout ()->self_scm (), properties, quant_score));
- the_beam.add_at_edge (Y_AXIS, stem_dir, tm, 1.0, 0);
+ Stencil score = *unsmob_stencil (Text_interface::interpret_markup
+ (me->layout ()->self_scm (), properties, annotation));
+
+ if (!score.is_empty ())
+ {
+ score.translate_axis (me->relative_coordinate (commonx, X_AXIS), X_AXIS);
+ the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0);
+ }
}
#endif
+ the_beam.translate_axis (-me->relative_coordinate (commonx, X_AXIS), X_AXIS);
return the_beam.smobbed_copy ();
}
-
Direction
Beam::get_default_dir (Grob *me)
{
- Drul_array<int> total;
- total[UP] = total[DOWN] = 0;
- Drul_array<int> count;
- count[UP] = count[DOWN] = 0;
- Direction d = DOWN;
+ extract_grob_set (me, "stems", stems);
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ Drul_array<Real> extremes (0.0, 0.0);
+ for (iterof (s, stems); s != stems.end (); s++)
+ {
+ Interval positions = Stem::head_positions (*s);
+ for (DOWN_and_UP (d))
+ {
+ if (sign (positions[d]) == d)
+ extremes[d] = d * max (d * positions[d], d * extremes[d]);
+ }
+ }
- for (int i = 0; i < stems.size (); i++)
- do
- {
- Grob *s = stems[i];
- Direction sd = get_grob_direction (s);
+ Drul_array<int> total (0, 0);
+ Drul_array<int> count (0, 0);
- int center_distance = int (- d * Stem::head_positions (s) [-d]) >? 0;
- int current = sd ? (1 + d * sd) / 2 : center_distance;
+ bool force_dir = false;
+ for (vsize i = 0; i < stems.size (); i++)
+ {
+ Grob *s = stems[i];
+ Direction stem_dir = CENTER;
+ SCM stem_dir_scm = s->get_property_data ("direction");
+ if (is_direction (stem_dir_scm))
+ {
+ stem_dir = to_dir (stem_dir_scm);
+ force_dir = true;
+ }
+ else
+ stem_dir = to_dir (s->get_property ("default-direction"));
- if (current)
- {
- total[d] += current;
- count[d]++;
- }
- }
- while (flip (&d) != DOWN);
+ if (!stem_dir)
+ stem_dir = to_dir (s->get_property ("neutral-direction"));
- SCM func = me->get_property ("dir-function");
- SCM s = scm_call_2 (func,
- scm_cons (scm_int2num (count[UP]),
- scm_int2num (count[DOWN])),
- scm_cons (scm_int2num (total[UP]),
- scm_int2num (total[DOWN])));
+ if (stem_dir)
+ {
+ count[stem_dir]++;
+ total[stem_dir] += max (int (- stem_dir * Stem::head_positions (s) [-stem_dir]), 0);
+ }
+ }
+
+ if (!force_dir)
+ {
+ if (abs (extremes[UP]) > -extremes[DOWN])
+ return DOWN;
+ else if (extremes[UP] < -extremes[DOWN])
+ return UP;
+ }
- if (scm_is_number (s) && scm_to_int (s))
- return to_dir (s);
+ Direction dir = CENTER;
+ Direction d = CENTER;
+ if ((d = (Direction) sign (count[UP] - count[DOWN])))
+ dir = d;
+ else if (count[UP]
+ && count[DOWN]
+ && (d = (Direction) sign (total[UP] / count[UP] - total[DOWN] / count[DOWN])))
+ dir = d;
+ else if ((d = (Direction) sign (total[UP] - total[DOWN])))
+ dir = d;
+ else
+ dir = to_dir (me->get_property ("neutral-direction"));
- /* If dir is not determined: get default */
- return to_dir (me->get_property ("neutral-direction"));
+ return dir;
}
/* Set all stems with non-forced direction to beam direction.
void
Beam::set_stem_directions (Grob *me, Direction d)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ extract_grob_set (me, "stems", stems);
- for (int i = 0; i <stems.size (); i++)
+ for (vsize i = 0; i < stems.size (); i++)
{
Grob *s = stems[i];
- SCM forcedir = s->get_property ("direction");
+ SCM forcedir = s->get_property_data ("direction");
if (!to_dir (forcedir))
- set_grob_direction (s, d);
+ set_grob_direction (s, d);
}
}
this routine should take into account the stemlength scoring
of a possible knee/nonknee beam.
-
*/
void
Beam::consider_auto_knees (Grob *me)
if (!scm_is_number (scm))
return;
- Interval_set gaps;
-
- gaps.set_full ();
+ vector<Interval> forbidden_intervals;
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ extract_grob_set (me, "normal-stems", stems);
Grob *common = common_refpoint_of_array (stems, me, Y_AXIS);
Real staff_space = Staff_symbol_referencer::staff_space (me);
- Array<Interval> head_extents_array;
- for (int i = 0; i < stems.size (); i++)
+ vector<Interval> head_extents_array;
+ for (vsize i = 0; i < stems.size (); i++)
{
Grob *stem = stems[i];
- if (Stem::is_invisible (stem))
- continue;
Interval head_extents = Stem::head_positions (stem);
if (!head_extents.is_empty ())
- {
- head_extents[LEFT] += -1;
- head_extents[RIGHT] += 1;
- head_extents *= 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.
- */
- head_extents += stem->relative_coordinate (common, Y_AXIS);
-
- if (to_dir (stem->get_property ("direction")))
- {
- Direction stemdir = to_dir (stem->get_property ("direction"));
- head_extents[-stemdir] = -stemdir * infinity_f;
- }
- }
- head_extents_array.push (head_extents);
-
- gaps.remove_interval (head_extents);
+ {
+ head_extents[LEFT] += -1;
+ head_extents[RIGHT] += 1;
+ head_extents *= 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.
+ */
+ head_extents += stem->pure_relative_y_coordinate (common, 0, INT_MAX);
+
+ if (to_dir (stem->get_property_data ("direction")))
+ {
+ Direction stemdir = to_dir (stem->get_property ("direction"));
+ head_extents[-stemdir] = -stemdir * infinity_f;
+ }
+ }
+ head_extents_array.push_back (head_extents);
+
+ forbidden_intervals.push_back (head_extents);
}
Interval max_gap;
Real max_gap_len = 0.0;
- for (int i = gaps.allowed_regions_.size () -1; i >= 0; i--)
+ vector<Interval> allowed_regions
+ = Interval_set::interval_union (forbidden_intervals).complement ().intervals ();
+ for (vsize i = allowed_regions.size () - 1; i != VPOS; i--)
{
- Interval gap = gaps.allowed_regions_[i];
+ Interval gap = allowed_regions[i];
/*
- the outer gaps are not knees.
+ the outer gaps are not knees.
*/
if (isinf (gap[LEFT]) || isinf (gap[RIGHT]))
- continue;
+ continue;
if (gap.length () >= max_gap_len)
- {
- max_gap_len = gap.length ();
- max_gap = gap;
- }
+ {
+ max_gap_len = gap.length ();
+ max_gap = gap;
+ }
}
Real beam_translation = get_beam_translation (me);
- Real beam_thickness = Beam::get_thickness (me);
+ Real beam_thickness = Beam::get_beam_thickness (me);
int beam_count = Beam::get_beam_count (me);
Real height_of_beams = beam_thickness / 2
- + (beam_count - 1) * beam_translation;
+ + (beam_count - 1) * beam_translation;
Real threshold = scm_to_double (scm) + height_of_beams;
if (max_gap_len > threshold)
{
int j = 0;
- for (int i = 0; i < stems.size (); i++)
- {
- Grob *stem = stems[i];
- if (Stem::is_invisible (stem))
- continue;
+ for (vsize i = 0; i < stems.size (); i++)
+ {
+ Grob *stem = stems[i];
+ Interval head_extents = head_extents_array[j++];
- Interval head_extents = head_extents_array[j++];
+ Direction d = (head_extents.center () < max_gap.center ())
+ ? UP : DOWN;
- Direction d = (head_extents.center () < max_gap.center ()) ?
- UP : DOWN;
+ stem->set_property ("direction", scm_from_int (d));
- stem->set_property ("direction", scm_int2num (d));
-
- head_extents.intersect (max_gap);
- assert (head_extents.is_empty () || head_extents.length () < 1e-6);
- }
+ head_extents.intersect (max_gap);
+ assert (head_extents.is_empty () || head_extents.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)
+MAKE_SCHEME_CALLBACK (Beam, calc_stem_shorten, 1)
+SCM
+Beam::calc_stem_shorten (SCM smob)
{
+ Grob *me = unsmob_grob (smob);
+
/*
shortening looks silly for x staff beams
*/
if (is_knee (me))
- return;
+ return scm_from_int (0);
Real forced_fraction = 1.0 * forced_stem_count (me)
- / visible_stem_count (me);
+ / normal_stem_count (me);
int beam_count = get_beam_count (me);
SCM shorten_list = me->get_property ("beamed-stem-shorten");
if (shorten_list == SCM_EOL)
- return;
+ return scm_from_int (0);
Real staff_space = Staff_symbol_referencer::staff_space (me);
SCM shorten_elt
- = robust_list_ref (beam_count -1, shorten_list);
- Real shorten_f = scm_to_double (shorten_elt) * staff_space;
-
- /* your similar cute comment here */
- shorten_f *= forced_fraction;
-
- if (shorten_f)
- me->set_property ("shorten", scm_make_real (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;
-}
-
-void
-Beam::position_beam (Grob *me)
-{
- if (!me->is_live ())
- return;
- if (to_boolean (me->get_property ("positioning-done")))
- return;
+ = robust_list_ref (beam_count - 1, shorten_list);
+ Real shorten = scm_to_double (shorten_elt) * staff_space;
- me->set_property ("positioning-done", SCM_BOOL_T);
+ shorten *= forced_fraction;
- /* Copy to mutable list. */
- SCM s = ly_deep_copy (me->get_property ("positions"));
- me->set_property ("positions", s);
+ if (shorten)
+ return scm_from_double (shorten);
- if (scm_car (s) == SCM_BOOL_F)
- {
- // one wonders if such genericity is necessary --hwn.
- SCM callbacks = me->get_property ("position-callbacks");
- for (SCM i = callbacks; scm_is_pair (i); i = scm_cdr (i))
- scm_call_1 (scm_car (i), me->self_scm ());
- }
-
- set_stem_lengths (me);
+ return scm_from_double (0.0);
}
-void
-set_minimum_dy (Grob *me, Real *dy)
-{
- if (*dy)
- {
- /*
- If dy is smaller than the smallest quant, we
- get absurd direction-sign penalties.
- */
-
- Real ss = Staff_symbol_referencer::staff_space (me);
- Real thickness = Beam::get_thickness (me) / ss;
- Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
- Real sit = (thickness - slt) / 2;
- Real inter = 0.5;
- Real hang = 1.0 - (thickness - slt) / 2;
-
- *dy = sign (*dy) * (fabs (*dy)
- >?
- (sit <? inter <? hang));
- }
-}
-
-/*
- Compute a first approximation to the beam slope.
-*/
-MAKE_SCHEME_CALLBACK (Beam, least_squares, 1);
-SCM
-Beam::least_squares (SCM smob)
-{
- Grob *me = unsmob_grob (smob);
-
- int count = visible_stem_count (me);
- Interval pos (0, 0);
-
- if (count < 1)
- {
- me->set_property ("positions", ly_interval2scm (pos));
- return SCM_UNSPECIFIED;
- }
-
- Array<Real> x_posns;
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("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 slope = 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_property ("least-squares-dy",
- scm_make_real (pos[RIGHT] - pos[LEFT]));
- }
- else
- {
- Array<Offset> ideals;
- for (int i = 0; i < stems.size (); i++)
- {
- Grob *s = stems[i];
- if (Stem::is_invisible (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 (&slope, &y, ideals);
-
- dy = slope * dx;
-
- set_minimum_dy (me, &dy);
- me->set_property ("least-squares-dy", scm_make_real (dy));
- pos = Interval (y, (y + dy));
- }
-
- /*
- "position" is relative to the staff.
- */
- scale_drul (&pos, 1/ Staff_symbol_referencer::staff_space (me));
-
- me->set_property ("positions", ly_interval2scm (pos));
-
- return SCM_UNSPECIFIED;
-}
-
-/*
- 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.
-*/
-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<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
- Grob *commonx = common_refpoint_of_array (stems, me, X_AXIS);
- Grob *commony = common_refpoint_of_array (stems, me, Y_AXIS);
-
- Grob *fvs = first_visible_stem (me);
-
- if (!fvs)
- return SCM_UNSPECIFIED;
-
- Real x0 = fvs->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);
- }
-
- 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_property ("positions"));
-
- scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
-
- Real dy = pos[RIGHT] - pos[LEFT];
- Real y = pos[LEFT];
- Real slope = 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++)
- {
- Grob *s = stems[i];
- if (Stem::is_invisible (s))
- continue;
-
- Direction d = Stem::get_direction (s);
-
- Real left_y
- = Stem::get_stem_info (s).shortest_y_
- - slope * x_posns [i];
-
- /*
- 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;
-
- feasible_left_point.intersect (flp);
- }
-
- if (feasible_left_point.is_empty ())
- warning (_ ("no viable initial configuration found: may not find good beam slope"));
- else if (!feasible_left_point.contains (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 = Drul_array<Real> (y, (y + dy));
- scale_drul (&pos, 1/ Staff_symbol_referencer::staff_space (me));
-
- me->set_property ("positions", ly_interval2scm (pos));
- return SCM_UNSPECIFIED;
-}
-
-/* This neat trick is by Werner Lemberg,
- damped = tanh (slope)
- corresponds with some tables in [Wanske] CHECKME */
-MAKE_SCHEME_CALLBACK (Beam, slope_damping, 1);
+MAKE_SCHEME_CALLBACK (Beam, quanting, 3);
SCM
-Beam::slope_damping (SCM smob)
+Beam::quanting (SCM smob, SCM ys_scm, SCM align_broken_intos)
{
Grob *me = unsmob_grob (smob);
+ Drul_array<Real> ys = robust_scm2drul (ys_scm, Drul_array<Real> (infinity_f, -infinity_f));
+ bool cbs = to_boolean (align_broken_intos);
- if (visible_stem_count (me) <= 1)
- return SCM_UNSPECIFIED;
+ Beam_scoring_problem problem (me, ys, cbs);
+ ys = problem.solve ();
- SCM s = me->get_property ("damping");
- Real damping = scm_to_double (s);
-
- if (damping)
- {
- Drul_array<Real> pos = ly_scm2interval (me->get_property ("positions"));
- scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
-
- Real dy = pos[RIGHT] - pos[LEFT];
-
- Grob *fvs = first_visible_stem (me);
- Grob *lvs = last_visible_stem (me);
-
- Grob *commonx = fvs->common_refpoint (lvs, X_AXIS);
-
- Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
- - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
-
- Real slope = dy && dx ? dy / dx : 0;
-
- Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
-
- slope = 0.6 * tanh (slope) / (damping + concaveness);
-
- Real damped_dy = slope * dx;
-
- set_minimum_dy (me, &damped_dy);
-
- pos[LEFT] += (dy - damped_dy) / 2;
- pos[RIGHT] -= (dy - damped_dy) / 2;
-
- scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me));
-
- me->set_property ("positions", ly_interval2scm (pos));
- }
- return SCM_UNSPECIFIED;
+ return ly_interval2scm (ys);
}
/*
{
if (scm_c_memq (scm_car (s), scm_cdr (beaming)) != SCM_BOOL_F)
- l.add_point (scm_to_int (scm_car (s)));
+ l.add_point (scm_to_int (scm_car (s)));
}
return l;
/* 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)
+Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common,
+ Real xl, Real xr, Direction feather_dir,
+ Drul_array<Real> pos, bool french)
{
Real beam_translation = get_beam_translation (me);
+ Direction stem_dir = get_grob_direction (stem);
- 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];
+ Real relx = dx ? (stem->relative_coordinate (common[X_AXIS], X_AXIS) - xl) / dx : 0;
+ Real xdir = 2 * relx - 1;
- Direction my_dir = get_grob_direction (s);
- SCM beaming = s->get_property ("beaming");
+ Real stem_y = linear_combination (pos, xdir);
- Real stem_y = stem_y_beam0;
- if (french)
- {
- 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;
- }
+ SCM beaming = stem->get_property ("beaming");
+
+ Slice beam_slice (french
+ ? where_are_the_whole_beams (beaming)
+ : Stem::beam_multiplicity (stem));
+ if (beam_slice.is_empty ())
+ beam_slice = Slice (0, 0);
+ Interval beam_multiplicity (beam_slice[LEFT],
+ beam_slice[RIGHT]);
+ /*
+ feather dir = 1 , relx 0->1 : factor 0 -> 1
+ feather dir = 0 , relx 0->1 : factor 1 -> 1
+ feather dir = -1, relx 0->1 : factor 1 -> 0
+ */
+ Real feather_factor = 1;
+ if (feather_dir > 0)
+ feather_factor = relx;
+ else if (feather_dir < 0)
+ feather_factor = 1 - relx;
+
+ stem_y += feather_factor * beam_translation
+ * beam_multiplicity[Direction (((french) ? DOWN : UP) * stem_dir)];
Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
- - s->relative_coordinate (common[Y_AXIS], Y_AXIS);
+ - stem->relative_coordinate (common[Y_AXIS], Y_AXIS);
return stem_y + id;
}
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)
+MAKE_SCHEME_CALLBACK (Beam, set_stem_lengths, 1);
+SCM
+Beam::set_stem_lengths (SCM smob)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ Grob *me = unsmob_grob (smob);
+
+ /* trigger callbacks. */
+ (void) me->get_property ("direction");
+ (void) me->get_property ("beaming");
+ SCM posns = me->get_property ("positions");
+
+ extract_grob_set (me, "stems", stems);
if (!stems.size ())
- return;
+ return posns;
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_property ("positions"));
+ Drul_array<Real> pos = ly_scm2realdrul (posns);
Real staff_space = Staff_symbol_referencer::staff_space (me);
scale_drul (&pos, staff_space);
bool gap = false;
Real thick = 0.0;
- if (scm_is_number (me->get_property ("gap-count"))
- &&scm_to_int (me->get_property ("gap-count")))
+ if (robust_scm2int (me->get_property ("gap-count"), 0))
{
gap = true;
- thick = get_thickness (me);
+ thick = get_beam_thickness (me);
}
- // ugh -> use commonx
- Grob *fvs = first_visible_stem (me);
- Grob *lvs = last_visible_stem (me);
+ Grob *fvs = first_normal_stem (me);
+ Grob *lvs = last_normal_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;
+ Interval x_span = robust_scm2interval (me->get_property ("X-positions"), Interval (0, 0));
+ Direction feather_dir = to_dir (me->get_property ("grow-direction"));
- for (int i = 0; i < stems.size (); i++)
+ for (vsize i = 0; i < stems.size (); i++)
{
Grob *s = stems[i];
- if (Stem::is_invisible (s))
- continue;
bool french = to_boolean (s->get_property ("french-beaming"));
Real stem_y = calc_stem_y (me, s, common,
- xl, xr,
- pos, french && s != lvs && s!= fvs);
+ x_span[LEFT], x_span[RIGHT], feather_dir,
+ pos, french && s != lvs && s != fvs);
/*
- 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.
+ 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);
+ if (gap
+ && !Stem::is_invisible (s))
+ stem_y += thick * 0.5 * get_grob_direction (s);
- Stem::set_stemend (s, 2* stem_y / staff_space);
+ /*
+ Do set_stem_positions for invisible stems too, so tuplet brackets
+ have a reference point for sloping
+ */
+ Stem::set_stem_positions (s, 2 * stem_y / staff_space);
}
+
+ return posns;
}
void
-Beam::set_beaming (Grob *me, Beaming_info_list *beaming)
+Beam::set_beaming (Grob *me, Beaming_pattern const *beaming)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ extract_grob_set (me, "stems", stems);
- Direction d = LEFT;
- for (int i = 0; i < stems.size (); i++)
+ for (vsize i = 0; i < stems.size (); i++)
{
/*
- Don't overwrite user settings.
+ 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_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::is_invisible (st))
- b = b <? beaming->infos_.elem (i).beams_i_drul_[-d];
-
- Stem::set_beaming (st, b, d);
- }
- }
- while (flip (&d) != LEFT);
+ for (LEFT_and_RIGHT (d))
+ {
+ Grob *stem = stems[i];
+ SCM beaming_prop = stem->get_property ("beaming");
+ if (beaming_prop == SCM_EOL
+ || index_get_cell (beaming_prop, d) == SCM_EOL)
+ {
+ int count = beaming->beamlet_count (i, d);
+ if (i > 0
+ && i + 1 < stems.size ()
+ && Stem::is_invisible (stem))
+ count = min (count, beaming->beamlet_count (i, -d));
+
+ if ( ((i == 0 && d == LEFT)
+ || (i == stems.size () - 1 && d == RIGHT))
+ && stems.size () > 1
+ && to_boolean (me->get_property ("clip-edges")))
+ count = 0;
+
+ Stem::set_beaming (stem, count, d);
+ }
+ }
}
}
int
Beam::forced_stem_count (Grob *me)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ extract_grob_set (me, "normal-stems", stems);
+
int f = 0;
- for (int i = 0; i < stems.size (); i++)
+ for (vsize i = 0; i < stems.size (); i++)
{
Grob *s = stems[i];
- if (Stem::is_invisible (s))
- continue;
-
/* I can imagine counting those boundaries as a half forced stem,
- but let's count them full for now. */
+ but let's count them full for now. */
+ Direction defdir = to_dir (s->get_property ("default-direction"));
+
if (abs (Stem::chord_start_y (s)) > 0.1
- && (Stem::get_direction (s) != Stem::get_default_dir (s)))
- f++;
+ && defdir
+ && get_grob_direction (s) != defdir)
+ f++;
}
return f;
}
-
int
-Beam::visible_stem_count (Grob *me)
+Beam::normal_stem_count (Grob *me)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
- int c = 0;
- for (int i = stems.size (); i--;)
- {
- if (!Stem::is_invisible (stems[i]))
- c++;
- }
- return c;
+ extract_grob_set (me, "normal-stems", stems);
+ return stems.size ();
}
Grob *
-Beam::first_visible_stem (Grob *me)
+Beam::first_normal_stem (Grob *me)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
-
- for (int i = 0; i < stems.size (); i++)
- {
- if (!Stem::is_invisible (stems[i]))
- return stems[i];
- }
- return 0;
+ extract_grob_set (me, "normal-stems", stems);
+ return stems.size () ? stems[0] : 0;
}
Grob *
-Beam::last_visible_stem (Grob *me)
+Beam::last_normal_stem (Grob *me)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
- for (int i = stems.size (); i--;)
- {
- if (!Stem::is_invisible (stems[i]))
- return stems[i];
- }
- return 0;
+ extract_grob_set (me, "normal-stems", stems);
+ return stems.size () ? stems.back () : 0;
}
/*
rest -> stem -> beam -> interpolate_y_position ()
*/
-MAKE_SCHEME_CALLBACK (Beam, rest_collision_callback, 2);
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Beam, rest_collision_callback, 2, 1, "");
SCM
-Beam::rest_collision_callback (SCM element_smob, SCM axis)
+Beam::rest_collision_callback (SCM smob, SCM prev_offset)
{
- Grob *rest = unsmob_grob (element_smob);
- Axis a = (Axis) scm_to_int (axis);
-
+ Grob *rest = unsmob_grob (smob);
if (scm_is_number (rest->get_property ("staff-position")))
- return scm_int2num (0);
+ return scm_from_int (0);
- assert (a == Y_AXIS);
+ Real offset = robust_scm2double (prev_offset, 0.0);
- Grob *st = unsmob_grob (rest->get_property ("stem"));
+ Grob *st = unsmob_grob (rest->get_object ("stem"));
Grob *stem = st;
if (!stem)
- return scm_make_real (0.0);
- Grob *beam = unsmob_grob (stem->get_property ("beam"));
+ return scm_from_double (0.0);
+ Grob *beam = unsmob_grob (stem->get_object ("beam"));
if (!beam
|| !Beam::has_interface (beam)
- || !Beam::visible_stem_count (beam))
- return scm_make_real (0.0);
+ || !Beam::normal_stem_count (beam))
+ return scm_from_double (0.0);
+
+ Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
+
+ Drul_array<Real> pos (robust_scm2drul (beam->get_property ("positions"),
+ Drul_array<Real> (0, 0)));
+
+ for (LEFT_and_RIGHT (dir))
+ pos[dir] += beam->relative_coordinate (common_y, Y_AXIS);
- Drul_array<Real> pos (0, 0);
- SCM s = beam->get_property ("positions");
- if (scm_is_pair (s) && scm_is_number (scm_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;
+ extract_grob_set (beam, "stems", stems);
+ Grob *common = common_refpoint_of_array (stems, beam, X_AXIS);
+
+ Interval x_span = robust_scm2interval (beam->get_property ("X-positions"),
+ Interval (0.0, 0.0));
+ Real x0 = x_span[LEFT];
+ Real dx = x_span.length ();
Real slope = dy && dx ? dy / dx : 0;
- Direction d = Stem::get_direction (stem);
- Real stem_y = pos[LEFT] + (stem->relative_coordinate (0, X_AXIS) - x0) * slope;
+ Direction d = get_grob_direction (stem);
+ Real stem_y = pos[LEFT]
+ + (stem->relative_coordinate (common, X_AXIS) - x0) * slope;
Real beam_translation = get_beam_translation (beam);
- Real beam_thickness = Beam::get_thickness (beam);
+ Real beam_thickness = Beam::get_beam_thickness (beam);
/*
TODO: this is not strictly correct for 16th knee beams.
= Stem::beam_multiplicity (stem).length () + 1;
Real height_of_my_beams = beam_thickness / 2
- + (beam_count - 1) * beam_translation;
+ + (beam_count - 1) * beam_translation;
Real beam_y = stem_y - d * height_of_my_beams;
- Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
+ Interval rest_extent = rest->extent (rest, Y_AXIS);
+ rest_extent.translate (offset + rest->get_parent (Y_AXIS)->relative_coordinate (common_y, Y_AXIS));
- Real rest_dim = rest->extent (common_y, Y_AXIS)[d];
+ Real rest_dim = rest_extent[d];
Real minimum_distance
- = + staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
- + robust_scm2double (rest->get_property ("minimum-distance"), 0.0));
+ = staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
+ + robust_scm2double (rest->get_property ("minimum-distance"), 0.0));
- Real shift = d * (((beam_y - d * minimum_distance) - rest_dim) * d <? 0.0);
+ Real shift = d * min (d * (beam_y - d * minimum_distance - rest_dim), 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);
+ Interval staff_span = Staff_symbol_referencer::staff_span (rest);
+ staff_span *= staff_space / 2;
+
/* 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);
+ if (staff_span.contains (rest_extent[d] + staff_space * shift)
+ || staff_span.contains (rest_extent[-d] + staff_space * shift))
+ shift = ceil (fabs (shift)) * sign (shift);
+
+ return scm_from_double (offset + staff_space * shift);
+}
+
+/*
+ Estimate the position of a rest under a beam,
+ as the average position of its neighboring heads.
+*/
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Beam, pure_rest_collision_callback, 4, 1, "");
+SCM
+Beam::pure_rest_collision_callback (SCM smob,
+ SCM, /* start */
+ SCM, /* end */
+ SCM prev_offset)
+{
+ Real previous = robust_scm2double (prev_offset, 0.0);
+
+ Grob *me = unsmob_grob (smob);
+ Grob *stem = unsmob_grob (me->get_object ("stem"));
+ if (!stem)
+ return scm_from_double (previous);
+ Grob *beam = unsmob_grob (stem->get_object ("beam"));
+ if (!beam
+ || !Beam::normal_stem_count (beam)
+ || !is_direction (beam->get_property_data ("direction")))
+ return scm_from_double (previous);
+
+ Real ss = Staff_symbol_referencer::staff_space (me);
+
+ /*
+ This gives the extrema of rest positions.
+ Even with noteheads on ledgers, beams typically remain within the staff,
+ and push rests at most one staff-space (2 positions) from the staff.
+ */
+ Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+ Interval rest_max_pos = staff ? Staff_symbol::line_span (staff) : Interval (0.0, 0.0);
+ rest_max_pos.widen (2);
+
+ extract_grob_set (beam, "stems", stems);
+ vector<Grob *> my_stems;
+
+ for (vsize i = 0; i < stems.size (); i++)
+ if (Stem::head_count (stems[i]) || stems[i] == stem)
+ my_stems.push_back (stems[i]);
+
+ vsize idx = -1;
+
+ for (vsize i = 0; i < my_stems.size (); i++)
+ if (my_stems[i] == stem)
+ {
+ idx = i;
+ break;
+ }
+ Grob *left;
+ Grob *right;
+
+ if (idx == (vsize) - 1 || my_stems.size () == 1)
+ return scm_from_double (previous);
+ else if (idx == 0)
+ left = right = my_stems[1];
+ else if (idx == my_stems.size () - 1)
+ left = right = my_stems[idx - 1];
+ else
+ {
+ left = my_stems[idx - 1];
+ right = my_stems[idx + 1];
+ }
+
+ /* In stems with several heads, use the one closest to the beam. */
+ Direction beamdir = get_grob_direction (beam);
+ Real shift = min (max ( (Stem::head_positions (left)[beamdir]
+ + Stem::head_positions (right)[beamdir]) / 2.0,
+ rest_max_pos[DOWN]),
+ rest_max_pos[UP]
+ ) * ss / 2.0
+ - previous;
- return scm_make_real (staff_space * shift);
+ // So that ceil below kicks in for rests that would otherwise brush
+ // up against a beam quanted to a ledger line, add a bit of space
+ // between the beam and the rest.
+ shift += (0.01 * beamdir);
+
+ /* Always move by a whole number of staff spaces */
+ shift = ceil (fabs (shift / ss)) * ss * sign (shift);
+
+ return scm_from_double (previous + shift);
}
bool
bool knee = false;
int d = 0;
- for (SCM s = me->get_property ("stems"); scm_is_pair (s); s = scm_cdr (s))
+ extract_grob_set (me, "stems", stems);
+ for (vsize i = stems.size (); i--;)
{
- Direction dir = get_grob_direction (unsmob_grob (scm_car (s)));
+ Direction dir = get_grob_direction (stems[i]);
if (d && d != dir)
- {
- knee = true;
- break;
- }
+ {
+ knee = true;
+ break;
+ }
d = dir;
}
return knee;
}
+bool
+Beam::is_cross_staff (Grob *me)
+{
+ extract_grob_set (me, "stems", stems);
+ Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me);
+ for (vsize i = 0; i < stems.size (); i++)
+ if (Staff_symbol_referencer::get_staff_symbol (stems[i]) != staff_symbol)
+ return true;
+ return false;
+}
+
+MAKE_SCHEME_CALLBACK (Beam, calc_cross_staff, 1)
+SCM
+Beam::calc_cross_staff (SCM smob)
+{
+ return scm_from_bool (is_cross_staff (unsmob_grob (smob)));
+}
+
int
Beam::get_direction_beam_count (Grob *me, Direction d)
{
- Link_array<Grob> stems
- = extract_grob_array (me, ly_symbol2scm ("stems"));
+ extract_grob_set (me, "stems", stems);
int bc = 0;
- for (int i = stems.size (); i--;)
+ for (vsize i = stems.size (); i--;)
{
/*
- Should we take invisible stems into account?
+ Should we take invisible stems into account?
*/
- if (Stem::get_direction (stems[i]) == d)
- bc = bc >? (Stem::beam_multiplicity (stems[i]).length () + 1);
+ if (get_grob_direction (stems[i]) == d)
+ bc = max (bc, (Stem::beam_multiplicity (stems[i]).length () + 1));
}
return bc;
}
-ADD_INTERFACE (Beam, "beam-interface",
- "A beam. \n\n"
- "The @code{thickness} property is the weight of beams, and is measured "
- "in staffspace",
- "knee positioning-done position-callbacks "
- "concaveness dir-function quant-score auto-knee-gap gap "
- "gap-count chord-tremolo beamed-stem-shorten shorten least-squares-dy "
- "damping inspect-quants flag-width-function neutral-direction positions space-function "
- "thickness");
-
+ADD_INTERFACE (Beam,
+ "A beam.\n"
+ "\n"
+ "The @code{beam-thickness} property is the weight of beams,"
+ " measured in staffspace. The @code{direction} property is"
+ " not user-serviceable. Use the @code{direction} property"
+ " of @code{Stem} instead.\n"
+ "The following properties may be set in the @code{details}"
+ " list.\n"
+ "\n"
+ "@table @code\n"
+ "@item stem-length-demerit-factor\n"
+ "Demerit factor used for inappropriate stem lengths.\n"
+ "@item secondary-beam-demerit\n"
+ "Demerit used in quanting calculations for multiple"
+ " beams.\n"
+ "@item region-size\n"
+ "Size of region for checking quant scores.\n"
+ "@item beam-eps\n"
+ "Epsilon for beam quant code to check for presence"
+ " in gap.\n"
+ "@item stem-length-limit-penalty\n"
+ "Penalty for differences in stem lengths on a beam.\n"
+ "@item damping-direction-penalty\n"
+ "Demerit penalty applied when beam direction is different"
+ " from damping direction.\n"
+ "@item hint-direction-penalty\n"
+ "Demerit penalty applied when beam direction is different"
+ " from damping direction, but damping slope is"
+ " <= @code{round-to-zero-slope}.\n"
+ "@item musical-direction-factor\n"
+ "Demerit scaling factor for difference between"
+ " beam slope and music slope.\n"
+ "@item ideal-slope-factor\n"
+ "Demerit scaling factor for difference between"
+ " beam slope and damping slope.\n"
+ "@item round-to-zero-slope\n"
+ "Damping slope which is considered zero for purposes of"
+ " calculating direction penalties.\n"
+ "@end table\n",
+
+ /* properties */
+ "annotation "
+ "auto-knee-gap "
+ "beamed-stem-shorten "
+ "beaming "
+ "beam-segments "
+ "beam-thickness "
+ "break-overshoot "
+ "clip-edges "
+ "concaveness "
+ "collision-interfaces "
+ "collision-voice-only "
+ "covered-grobs "
+ "damping "
+ "details "
+ "direction "
+ "gap "
+ "gap-count "
+ "grow-direction "
+ "inspect-quants "
+ "knee "
+ "length-fraction "
+ "least-squares-dy "
+ "neutral-direction "
+ "normal-stems "
+ "positions "
+ "quantized-positions "
+ "shorten "
+ "skip-quanting "
+ "stems "
+ "X-positions "
+ );