X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fbeam.cc;h=b4a98a36a70c764b01a886b200cc87d7cf3b545b;hb=57be7394ffa2e7d7ba6d60548dba563f3409d472;hp=2e0615baf4610425567523f377406af946f0f50c;hpb=fc3e875d6bf06f0680e897faffdcab36ad975a03;p=lilypond.git diff --git a/lily/beam.cc b/lily/beam.cc index 2e0615baf4..d8b2a37887 100644 --- a/lily/beam.cc +++ b/lily/beam.cc @@ -3,29 +3,37 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2001 Han-Wen Nienhuys - Jan Nieuwenhuizen - + (c) 1997--2005 Han-Wen Nienhuys + Jan Nieuwenhuizen */ /* - [TODO] + TODO: - * shorter! (now +- 1000 lines) - * less hairy code - */ + - 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 // tanh. -#include "molecule.hh" +#include "beam.hh" +#include "interval-set.hh" #include "directional-element-interface.hh" #include "beaming.hh" -#include "beam.hh" #include "misc.hh" #include "least-squares.hh" #include "stem.hh" -#include "paper-def.hh" +#include "output-def.hh" #include "lookup.hh" #include "group-interface.hh" #include "staff-symbol-referencer.hh" @@ -33,1036 +41,1376 @@ #include "spanner.hh" #include "warn.hh" +#if DEBUG_QUANTING +#include "text-item.hh" // debug output. +#include "font-interface.hh" // debug output. +#endif + void -Beam::add_stem (Grob*me, Grob*s) +Beam::add_stem (Grob *me, Grob *s) { - Pointer_group_interface:: add_element (me, "stems", s); - + Pointer_group_interface::add_grob (me, ly_symbol2scm ("stems"), s); + s->add_dependency (me); - assert (!Stem::beam_l (s)); - s->set_grob_property ("beam", me->self_scm ()); + assert (!Stem::get_beam (s)); + s->set_property ("beam", me->self_scm ()); - add_bound_item (dynamic_cast (me), dynamic_cast (s)); + add_bound_item (dynamic_cast (me), dynamic_cast (s)); } +Real +Beam::get_thickness (Grob *me) +{ + return robust_scm2double (me->get_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_property ("space-function"); + + 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; + } +} + +/* Maximum beam_count. */ int -Beam::get_multiplicity (Grob*me) +Beam::get_beam_count (Grob *me) { int m = 0; - for (SCM s = me->get_grob_property ("stems"); gh_pair_p (s); s = gh_cdr (s)) + for (SCM s = me->get_property ("stems"); scm_is_pair (s); s = scm_cdr (s)) { - Grob * sc = unsmob_grob (gh_car (s)); - - if (Stem::has_interface (sc)) - m = m >? Stem::beam_count (sc,LEFT) >? Stem::beam_count (sc,RIGHT); + Grob *stem = unsmob_grob (scm_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'.] - */ -MAKE_SCHEME_CALLBACK (Beam,before_line_breaking,1); + Space return space between beams. +*/ +MAKE_SCHEME_CALLBACK (Beam, space_function, 2); +SCM +Beam::space_function (SCM smob, SCM beam_count) +{ + 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; + + return scm_make_real (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); + Grob *me = unsmob_grob (smob); - // Why? - /* - Why what? Why the warning (beams with less than 2 stems are - degenerate beams, should never happen), or why would this ever - happen (don't know). */ - if (visible_stem_count (me) < 2) + /* 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) { - warning (_ ("beam has less than two stems")); + 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; + } } - if (visible_stem_count (me) >= 1) + if (count >= 1) { - if (!Directional_element_interface::get (me)) - Directional_element_interface::set (me, get_default_dir (me)); - + Direction d = get_default_dir (me); + consider_auto_knees (me); - set_stem_directions (me); + set_stem_directions (me, d); + + connect_beams (me); + set_stem_shorten (me); } + return SCM_EOL; } -Direction -Beam::get_default_dir (Grob*me) +/* 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) { - Drul_array total; - total[UP] = total[DOWN] = 0; - Drul_array count; - count[UP] = count[DOWN] = 0; - Direction d = DOWN; + Slice lslice = int_list_to_slice (scm_cdr (left_beaming)); - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); + 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 = 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++; + } - for (int i=0; i = best_count) + { + best_count = count; + best_start = i; + } + } + + return best_start; +} + +void +Beam::connect_beams (Grob *me) +{ + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("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_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)); - if (current) + 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; + } + else { - total[d] += current; - count[d] ++; + 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); + } } - } while (flip (&d) != DOWN); - - SCM func = me->get_grob_property ("dir-function"); - SCM s = gh_call2 (func, - gh_cons (gh_int2scm (count[UP]), - gh_int2scm (count[DOWN])), - gh_cons (gh_int2scm (total[UP]), - gh_int2scm (total[DOWN]))); + if (i == stems.size () -1) + { + scm_set_cdr_x (this_beaming, SCM_EOL); + } - 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 ("default-neutral-direction")); + if (scm_ilength (scm_cdr (this_beaming)) > 0) + { + last_beaming = this_beaming; + last_dir = this_dir; + } + } } - /* - 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) + TODO: should not make beams per stem, but per Y-level. +*/ +MAKE_SCHEME_CALLBACK (Beam, print, 1); +SCM +Beam::print (SCM grob) { - Link_array stems - =Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); - Direction d = Directional_element_interface::get (me); - - for (int i=0; i stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + Grob *xcommon = common_refpoint_of_array (stems, me, X_AXIS); + + xcommon = me->get_bound (LEFT)->common_refpoint (xcommon, X_AXIS); + xcommon = me->get_bound (RIGHT)->common_refpoint (xcommon, X_AXIS); + + Real x0, dx; + if (visible_stem_count (me)) { - Grob *s = stems[i]; - SCM force = s->remove_grob_property ("dir-forced"); - if (!gh_boolean_p (force) || !gh_scm2bool (force)) - Directional_element_interface ::set (s,d); + // 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; } -} -/* - Simplistic auto-knees; only consider vertical gap between two - adjacent chords. + SCM posns = me->get_property ("positions"); + Drul_array pos; + if (!is_number_pair (posns)) + { + programming_error ("no beam positions?"); + pos = Interval (0, 0); + } + else + pos = ly_scm2realdrul (posns); - `Forced' stem directions are ignored. If you don't want auto-knees, - don't set, or unset auto-knee-gap. - */ -void -Beam::consider_auto_knees (Grob *me) -{ - SCM scm = me->get_grob_property ("auto-knee-gap"); + scale_drul (&pos, Staff_symbol_referencer::staff_space (me)); + + Real dy = pos[RIGHT] - pos[LEFT]; + Real slope = (dy && dx) ? dy / dx : 0; + + Real thick = get_thickness (me); + Real bdy = get_beam_translation (me); - if (gh_number_p (scm)) + SCM last_beaming = SCM_EOL; + Real last_xposn = -1; + Real last_stem_width = -1; + + Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0); + + Stencil the_beam; + Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness")); + + for (int i = 0; i <= stems.size (); i++) { - bool knee_b = false; - Real knee_y = 0; - Real staff_space = Staff_symbol_referencer::staff_space (me); - Real gap = gh_scm2double (scm) / staff_space; - - Direction d = Directional_element_interface::get (me); - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); - - Grob *common = me->common_refpoint (stems[0], Y_AXIS); - for (int i=1; i < stems.size (); i++) - if (!Stem::invisible_b (stems[i])) - common = common->common_refpoint (stems[i], Y_AXIS); - - int l = 0; - for (int i=1; i < stems.size (); i++) - { - if (!Stem::invisible_b (stems[i-1])) - l = i - 1; - if (Stem::invisible_b (stems[l])) - continue; - if (Stem::invisible_b (stems[i])) - continue; - - Real left = Stem::extremal_heads (stems[l])[d] - ->relative_coordinate (common, Y_AXIS); - Real right = Stem::extremal_heads (stems[i])[-d] - ->relative_coordinate (common, Y_AXIS); + Grob *st = (i < stems.size ()) ? stems[i] : 0; - Real dy = right - left; + 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; + /* + 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) ? scm_cdr (last_beaming) : SCM_EOL; + SCM right = st ? scm_car (this_beaming) : SCM_EOL; - if (abs (dy) >= gap) + Array full_beams; + Array lfliebertjes; + Array 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) { - knee_y = (right + left) / 2; - knee_b = true; - break; + full_beams.push (b); + } + else + { + lfliebertjes.push (b); } } - - if (knee_b) + for (SCM s = right; + scm_is_pair (s); s = scm_cdr (s)) { - for (int i=0; i < stems.size (); i++) + int b = scm_to_int (scm_car (s)); + if (scm_c_memq (scm_car (s), left) == SCM_BOOL_F) { - if (Stem::invisible_b (stems[i])) - continue; - Item *s = stems[i]; - Real y = Stem::extremal_heads (stems[i])[d] - ->relative_coordinate (common, Y_AXIS); + 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; - Directional_element_interface::set (s, y < knee_y ? UP : DOWN); - s->set_grob_property ("dir-forced", SCM_BOOL_T); + 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 get_bound (LEFT)->extent (xcommon, X_AXIS)[RIGHT] + - 0.5; + + if (st) + lw = nw_f 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; } + + 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_property ("quant-score"); + if (to_boolean (me->get_layout ()->lookup_variable (ly_symbol2scm ("debug-beam-quanting"))) + && scm_is_string (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::text_font_alist_chain (me); + + 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); + } +#endif + + return the_beam.smobbed_copy (); } -/* - Set stem's shorten property if unset. - TODO: - take some y-position (chord/beam/nearest?) into account - scmify forced-fraction - */ +Direction +Beam::get_default_dir (Grob *me) +{ + Drul_array total; + total[UP] = total[DOWN] = 0; + Drul_array count; + count[UP] = count[DOWN] = 0; + Direction d = DOWN; + + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("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_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 (scm_is_number (s) && scm_to_int (s)) + return to_dir (s); + + /* If dir is not determined: get default */ + return to_dir (me->get_property ("neutral-direction")); +} + +/* 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_shorten (Grob*m) +Beam::set_stem_directions (Grob *me, Direction d) { - Spanner*me = dynamic_cast (m); + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); - Real forced_fraction = forced_stem_count (me) / visible_stem_count (me); - if (forced_fraction < 0.5) - return; + for (int i = 0; i < stems.size (); i++) + { + Grob *s = stems[i]; - int multiplicity = get_multiplicity (me); + SCM forcedir = s->get_property ("direction"); + if (!to_dir (forcedir)) + set_grob_direction (s, d); + } +} - SCM shorten = me->get_grob_property ("beamed-stem-shorten"); - if (shorten == SCM_EOL) +/* + 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. + + + TODO: + + this routine should take into account the stemlength scoring + of a possible knee/nonknee beam. +*/ +void +Beam::consider_auto_knees (Grob *me) +{ + SCM scm = me->get_property ("auto-knee-gap"); + if (!scm_is_number (scm)) return; - int sz = scm_ilength (shorten); - + Interval_set gaps; + + gaps.set_full (); + + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + + Grob *common = common_refpoint_of_array (stems, me, Y_AXIS); Real staff_space = Staff_symbol_referencer::staff_space (me); - SCM shorten_elt = scm_list_ref (shorten, gh_int2scm (multiplicity head_extents_array; + for (int 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); + } - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); + Interval max_gap; + Real max_gap_len = 0.0; - for (int i=0; i < stems.size (); i++) + for (int i = gaps.allowed_regions_.size () -1; i >= 0; i--) { - Item* s = stems[i]; - if (Stem::invisible_b (s)) - continue; - if (gh_number_p (s->get_grob_property ("shorten"))) - s->set_grob_property ("shorten", gh_double2scm (shorten_f)); + 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; + } + } + + Real beam_translation = get_beam_translation (me); + Real beam_thickness = Beam::get_thickness (me); + int beam_count = Beam::get_beam_count (me); + Real height_of_beams = beam_thickness / 2 + + (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; + + Interval head_extents = head_extents_array[j++]; + + Direction d = (head_extents.center () < max_gap.center ()) + ? UP : DOWN; + + stem->set_property ("direction", scm_int2num (d)); + + head_extents.intersect (max_gap); + assert (head_extents.is_empty () || head_extents.length () < 1e-6); + } } } -/* - Call list of y-dy-callbacks, that handle setting of - grob-properties y, dy. +/* Set stem's shorten property if unset. - User may set grob-properties: y-position-hs and height-hs - (to be fixed) that override the calculated y and dy. +TODO: +take some y-position (chord/beam/nearest?) into account +scmify forced-fraction - Because y and dy cannot be calculated and quanted separately, we - always calculate both, then check for user override. - */ +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 (is_knee (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_property ("beamed-stem-shorten"); + if (shorten_list == SCM_EOL) + return; + + 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); - - me->set_grob_property ("y", gh_double2scm (0)); - me->set_grob_property ("dy", gh_double2scm (0)); - - /* Hmm, callbacks should be called by, a eh, callback mechanism - somewhere (?), I guess, not by looping here. */ - - SCM list = me->get_grob_property ("y-dy-callbacks"); - for (SCM i = list; gh_pair_p (i); i = gh_cdr (i)) - gh_call1 (gh_car (i), smob); - - // UGH. Y is not in staff position unit? - // Ik dacht datwe daar juist van weg wilden? - - // Hmm, nu hebben we 3 dimensies, want inmiddels zijn we daar - // weer terug, maar dan / 2 - // (staff-space iso staff-position) - - set_stem_lengths (me); + 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; + + me->set_property ("positioning-done", SCM_BOOL_T); + + /* Copy to mutable list. */ + SCM s = ly_deep_copy (me->get_property ("positions")); + me->set_property ("positions", s); + + 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); +} + +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 set_property ("positions", ly_interval2scm (pos)); + return SCM_UNSPECIFIED; + } + + Array x_posns; + Link_array 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]; - if (visible_stem_count (me) <= 1) - return SCM_UNSPECIFIED; + 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; - /* Stem_info, and thus y,dy in this function are corrected for beam-dir */ - Real first_ideal = Stem::calc_stem_info (first_visible_stem (me)).idealy_f_; - if (first_ideal == Stem::calc_stem_info (last_visible_stem (me)).idealy_f_) + if (!ideal.delta ()) { - y = first_ideal; - dy = 0; + 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 ideals; - - // ugh -> use commonx - Real x0 = first_visible_stem (me)->relative_coordinate (0, X_AXIS); - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); - - for (int i=0; i < stems.size (); i++) + for (int i = 0; i < stems.size (); i++) { - Item* s = stems[i]; - if (Stem::invisible_b (s)) + Grob *s = stems[i]; + if (Stem::is_invisible (s)) continue; - ideals.push (Offset (s->relative_coordinate (0, X_AXIS) - x0, - Stem::calc_stem_info (s).idealy_f_)); + ideals.push (Offset (x_posns[i], + Stem::get_stem_info (s).ideal_y_ + + s->relative_coordinate (commony, Y_AXIS) + - my_y)); } - Real dydx; - minimise_least_squares (&dydx, &y, ideals); - Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - x0; - dy = dydx * dx; - } + minimise_least_squares (&slope, &y, ideals); - /* Store true, not dir-corrected values */ - Direction dir = Directional_element_interface::get (me); - me->set_grob_property ("y", gh_double2scm (y * dir)); - me->set_grob_property ("dy", gh_double2scm (dy * dir)); - return SCM_UNSPECIFIED; -} + dy = slope * dx; -MAKE_SCHEME_CALLBACK (Beam, cancel_suspect_slope, 1); -SCM -Beam::cancel_suspect_slope (SCM smob) -{ - Grob *me = unsmob_grob (smob); - - if (visible_stem_count (me) <= 1) - return SCM_UNSPECIFIED; - - /* Stem_info, and thus y,dy in this function are corrected for beam-dir */ - Direction dir = Directional_element_interface::get (me); - Real y = gh_scm2double (me->get_grob_property ("y")) * dir; - Real dy = gh_scm2double (me->get_grob_property ("dy")) * dir; - - /* steep slope running against lengthened stem is suspect */ - Real first_ideal = Stem::calc_stem_info (first_visible_stem (me)).idealy_f_; - Real last_ideal = Stem::calc_stem_info (last_visible_stem (me)).idealy_f_; - Real lengthened = gh_scm2double (me->get_grob_property ("outer-stem-length-limit")); - Real steep = gh_scm2double (me->get_grob_property ("slope-limit")); + set_minimum_dy (me, &dy); + me->set_property ("least-squares-dy", scm_make_real (dy)); + pos = Interval (y, (y + dy)); + } - // ugh -> use commonx - Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - first_visible_stem (me)->relative_coordinate (0, X_AXIS); - Real dydx = dy && dx ? dy/dx : 0; + /* + "position" is relative to the staff. + */ + scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me)); + + me->set_property ("positions", ly_interval2scm (pos)); - if (( (y - first_ideal > lengthened) && (dydx > steep)) - || ((y + dy - last_ideal > lengthened) && (dydx < -steep))) - { - Real adjusted_y = y + dy / 2; - /* Store true, not dir-corrected values */ - me->set_grob_property ("y", gh_double2scm (adjusted_y * dir)); - me->set_grob_property ("dy", gh_double2scm (0)); - } return SCM_UNSPECIFIED; } /* - This neat trick is by Werner Lemberg, - damped = tanh (slope) - corresponds with some tables in [Wanske] + 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, slope_damping, 1); +MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 1); SCM -Beam::slope_damping (SCM smob) +Beam::shift_region_to_valid (SCM grob) { - Grob *me = unsmob_grob (smob); + Grob *me = unsmob_grob (grob); + /* + Code dup. + */ + Array x_posns; + Link_array 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); - if (visible_stem_count (me) <= 1) - return SCM_UNSPECIFIED; + Grob *fvs = first_visible_stem (me); - SCM s = me->get_grob_property ("damping"); - int damping = gh_scm2int (s); + if (!fvs) + return SCM_UNSPECIFIED; - if (damping) + Real x0 = fvs->relative_coordinate (commonx, X_AXIS); + for (int i = 0; i < stems.size (); i++) { - /* y,dy in this function are corrected for beam-dir */ - Direction dir = Directional_element_interface::get (me); - Real y = gh_scm2double (me->get_grob_property ("y")) * dir; - Real dy = gh_scm2double (me->get_grob_property ("dy")) * dir; - - // ugh -> use commonx - Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - - first_visible_stem (me)->relative_coordinate (0, X_AXIS); - Real dydx = dy && dx ? dy/dx : 0; - dydx = 0.6 * tanh (dydx) / damping; - - Real damped_dy = dydx * dx; - Real adjusted_y = y + (dy - damped_dy) / 2; - /* Store true, not dir-corrected values */ - me->set_grob_property ("y", gh_double2scm (adjusted_y * dir)); - me->set_grob_property ("dy", gh_double2scm (damped_dy * dir)); + 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; -} -/* - Quantise dy (height) of beam. - Generalisation of [Ross]. - */ -MAKE_SCHEME_CALLBACK (Beam, quantise_dy, 1); -SCM -Beam::quantise_dy (SCM smob) -{ - Grob *me = unsmob_grob (smob); + Real dx = lvs->relative_coordinate (commonx, X_AXIS) - x0; - if (visible_stem_count (me) <= 1) - return SCM_UNSPECIFIED; + Drul_array pos = ly_scm2interval (me->get_property ("positions")); - Array a; - SCM proc = me->get_grob_property ("height-quants"); - SCM quants = gh_call2 (proc, me->self_scm (), - gh_double2scm (me->paper_l ()->get_var ("stafflinethickness") - / 1.0)); - - for (SCM s = quants; gh_pair_p (s); s = gh_cdr (s)) - a.push (gh_scm2double (gh_car (s))); - - if (a.size () > 1) - { - /* y,dy in this function are corrected for beam-dir */ - Direction dir = Directional_element_interface::get (me); - Real y = gh_scm2double (me->get_grob_property ("y")) * dir; - Real dy = gh_scm2double (me->get_grob_property ("dy")) * dir; - - Real staff_space = Staff_symbol_referencer::staff_space (me); - - Interval iv = quantise_iv (a, abs (dy)/staff_space) * staff_space; - Real q = (abs (dy) - iv[SMALLER] <= iv[BIGGER] - abs (dy)) - ? iv[SMALLER] - : iv[BIGGER]; - - Real quantised_dy = q * sign (dy); - Real adjusted_y = y + (dy - quantised_dy) / 2; - /* Store true, not dir-corrected values */ - me->set_grob_property ("y", gh_double2scm (adjusted_y * dir)); - me->set_grob_property ("dy", gh_double2scm (quantised_dy * dir)); - } - return SCM_UNSPECIFIED; -} + scale_drul (&pos, Staff_symbol_referencer::staff_space (me)); -/* It's tricky to have the user override y,dy directly, so we use this - translation func. Also, if our staff_space != 1 (smaller staff, eg), - user will expect staff-position to be discrete values. */ -MAKE_SCHEME_CALLBACK (Beam, user_override, 1); -SCM -Beam::user_override (SCM smob) -{ - Grob *me = unsmob_grob (smob); - Real staff_space = Staff_symbol_referencer::staff_space (me); + Real dy = pos[RIGHT] - pos[LEFT]; + Real y = pos[LEFT]; + Real slope = dy / dx; - SCM s = me->get_grob_property ("staff-position"); - if (gh_number_p (s)) + /* + 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++) { - Real y = gh_scm2double (s) * staff_space; - me->set_grob_property ("y", gh_double2scm (y)); + 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); } - /* Name suggestions? Tilt, slope, vertical-* ? */ - s = me->get_grob_property ("height"); - if (gh_number_p (s)) + 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)) { - Real dy = gh_scm2double (s) * staff_space; - me->set_grob_property ("dy", gh_double2scm (dy)); + 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 (y, (y + dy)); + scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me)); + + me->set_property ("positions", ly_interval2scm (pos)); return SCM_UNSPECIFIED; } -/* - Ugh, this must be last, after user_override - Assumes directionised y/dy. - */ -MAKE_SCHEME_CALLBACK (Beam, do_quantise_y, 1); +/* 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::do_quantise_y (SCM smob) +Beam::slope_damping (SCM smob) { Grob *me = unsmob_grob (smob); - /* - If the user set y-position, we shouldn't do quanting. - */ - if (gh_number_p (me->get_grob_property ("y-position-hs"))) + if (visible_stem_count (me) <= 1) return SCM_UNSPECIFIED; - Real y = gh_scm2double (me->get_grob_property ("y")); - Real dy = gh_scm2double (me->get_grob_property ("dy")); - - /* we can modify y, so we should quantise y */ - Real half_space = Staff_symbol_referencer::staff_space (me) / 2; - Real y_shift = check_stem_length_f (me, y, dy); - y += y_shift; - y = quantise_y_f (me, y, dy, 0); - - /* - Hmm, this is a bit keyhole operation: we're passing `this' as a - parameter, and member vars as SCM properties. We should decide on - SCM/C/C++ boundary */ - me->set_grob_property ("y", gh_double2scm (y)); - set_stem_lengths (me); - y = gh_scm2double (me->get_grob_property ("y")); - - y_shift = check_stem_length_f (me, y, dy); + SCM s = me->get_property ("damping"); + Real damping = scm_to_double (s); - if (y_shift > half_space / 4) + if (damping) { - y += y_shift; - - /* - for significantly lengthened or shortened stems, - request quanting the other way. - */ - int quant_dir = 0; - if (abs (y_shift) > half_space / 2) - quant_dir = sign (y_shift) * Directional_element_interface::get (me); - y = quantise_y_f (me, y, dy, quant_dir); - } - - me->set_grob_property ("y", gh_double2scm (y)); - // me->set_grob_property ("dy", gh_double2scm (dy)); - return SCM_UNSPECIFIED; -} - + Drul_array pos = ly_scm2interval (me->get_property ("positions")); + scale_drul (&pos, Staff_symbol_referencer::staff_space (me)); -Real -Beam::calc_stem_y_f (Grob*me,Item* s, Real y, Real dy) -{ - int beam_multiplicity = get_multiplicity (me); - int stem_multiplicity = (Stem::flag_i (s) - 2) >? 0; + Real dy = pos[RIGHT] - pos[LEFT]; - SCM space_proc = me->get_grob_property ("space-function"); - SCM space = gh_call1 (space_proc, gh_int2scm (beam_multiplicity)); + Grob *fvs = first_visible_stem (me); + Grob *lvs = last_visible_stem (me); - Real thick = gh_scm2double (me->get_grob_property ("thickness")) ; - Real interbeam_f = gh_scm2double (space) ; + Grob *commonx = fvs->common_refpoint (lvs, X_AXIS); - // ugh -> use commonx - Real x0 = first_visible_stem (me)->relative_coordinate (0, X_AXIS); - Real dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - x0; - Real stem_y = (dy && dx ? (s->relative_coordinate (0, X_AXIS) - x0) / dx * dy : 0) + y; - - /* knee */ - Direction dir = Directional_element_interface::get (me); - Direction sdir = Directional_element_interface::get (s); - - /* knee */ - if (dir!= sdir) - { - stem_y -= dir - * (thick / 2 + (beam_multiplicity - 1) * interbeam_f); + 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; - - // huh, why not for first visible? - if (Staff_symbol_referencer::staff_symbol_l (s) - != Staff_symbol_referencer::staff_symbol_l (last_visible_stem (me))) - stem_y += Directional_element_interface::get (me) - * (beam_multiplicity - stem_multiplicity) * interbeam_f; - } + Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0); - return stem_y; -} + slope = 0.6 * tanh (slope) / (damping + concaveness); -Real -Beam::check_stem_length_f (Grob*me,Real y, Real dy) -{ - Real shorten = 0; - Real lengthen = 0; - Direction dir = Directional_element_interface::get (me); + Real damped_dy = slope * dx; - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); + set_minimum_dy (me, &damped_dy); - for (int i=0; i < stems.size (); i++) - { - Item* s = stems[i]; - if (Stem::invisible_b (s)) - continue; + pos[LEFT] += (dy - damped_dy) / 2; + pos[RIGHT] -= (dy - damped_dy) / 2; - Real stem_y = calc_stem_y_f (me, s, y, dy); - - stem_y *= dir; - Stem_info info = Stem::calc_stem_info (s); + scale_drul (&pos, 1 / Staff_symbol_referencer::staff_space (me)); - // if (0 > info.maxy_f_ - stem_y) - shorten = shorten ? info.miny_f_ - stem_y; + me->set_property ("positions", ly_interval2scm (pos)); } - - if (lengthen && shorten) - warning (_ ("weird beam vertical offset")); - - /* when all stems are too short, normal stems win */ - return dir * ((shorten) ? shorten : lengthen); + return SCM_UNSPECIFIED; } /* - 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) + Report slice containing the numbers that are both in (car BEAMING) + and (cdr BEAMING) +*/ +Slice +where_are_the_whole_beams (SCM beaming) { - if (visible_stem_count (me) <= 1) - return; - - Real y = gh_scm2double (me->get_grob_property ("y")); - Real dy = gh_scm2double (me->get_grob_property ("dy")); - - Real half_space = Staff_symbol_referencer::staff_space (me)/2; - Link_array stems= - Pointer_group_interface__extract_elements (me, (Item*)0, "stems"); + Slice l; - Grob *common = me->common_refpoint (stems[0], Y_AXIS); - for (int i=1; i < stems.size (); i++) - if (!Stem::invisible_b (stems[i])) - common = common->common_refpoint (stems[i], Y_AXIS); - - for (int i=0; i < stems.size (); i++) + for (SCM s = scm_car (beaming); scm_is_pair (s); s = scm_cdr (s)) { - Item* s = stems[i]; - if (Stem::invisible_b (s)) - continue; + if (scm_c_memq (scm_car (s), scm_cdr (beaming)) != SCM_BOOL_F) - Real stem_y = calc_stem_y_f (me, s, y, dy); - - /* caution: stem measures in staff-positions */ - Real id = me->relative_coordinate (common, Y_AXIS) - - stems[i]->relative_coordinate (common, Y_AXIS); - Stem::set_stemend (s, (stem_y + id) / half_space); + l.add_point (scm_to_int (scm_car (s))); } -} -/* - Prevent interference from stafflines and beams. + return l; +} - We only need to quantise the (left) y of the beam, - since dy is quantised too. - if extend_b then stems must *not* get shorter - */ +/* 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::quantise_y_f (Grob*me,Real y, Real dy, int quant_dir) +Beam::calc_stem_y (Grob *me, Grob *s, Grob ** common, + Real xl, Real xr, + Drul_array pos, bool french) { - int multiplicity = get_multiplicity (me); - - Real staff_space = Staff_symbol_referencer::staff_space (me); - Real thick = me->paper_l ()->get_var ("stafflinethickness"); - + Real beam_translation = get_beam_translation (me); - SCM proc = me->get_grob_property ("vertical-position-quant-function"); - SCM quants = scm_apply (proc, - me->self_scm (), - gh_list (gh_int2scm (multiplicity), - gh_double2scm (dy/staff_space), - gh_double2scm (thick/staff_space), - SCM_EOL, SCM_UNDEFINED)); - - Array a; + 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]; - for (; gh_pair_p (quants); quants = gh_cdr (quants)) - a.push (gh_scm2double (gh_car (quants))); + Direction my_dir = get_grob_direction (s); + SCM beaming = s->get_property ("beaming"); - if (a.size () <= 1) - return y; - - Real up_y = Directional_element_interface::get (me) * y; - Interval iv = quantise_iv (a, up_y/staff_space) * staff_space; + 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; + } - Real q = up_y - iv[SMALLER] <= iv[BIGGER] - up_y - ? iv[SMALLER] : iv[BIGGER]; - if (quant_dir) - q = iv[ (Direction)quant_dir]; + Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS) + - s->relative_coordinate (common[Y_AXIS], Y_AXIS); - return q * Directional_element_interface::get (me); + 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_beaming (Grob*me,Beaming_info_list *beaming) +Beam::set_stem_lengths (Grob *me) { - Link_array stems= - Pointer_group_interface__extract_elements (me, (Grob*)0, "stems"); - - Direction d = LEFT; - for (int i=0; i < stems.size (); i++) - { - do - { - /* Don't overwrite user override (?) */ - if (Stem::beam_count (stems[i], d) == 0 - /* Don't set beaming for outside of outer stems */ - && ! (d == LEFT && i == 0) - && ! (d == RIGHT && i == stems.size () -1)) - { - int b = beaming->infos_.elem (i).beams_i_drul_[d]; - Stem::set_beaming (stems[i], b, d); - } - } - while (flip (&d) != LEFT); - } -} + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + if (!stems.size ()) + return; + Grob *common[2]; + for (int a = 2; a--;) + common[a] = common_refpoint_of_array (stems, me, Axis (a)); -/* - beams to go with one stem. + Drul_array pos = ly_scm2realdrul (me->get_property ("positions")); + Real staff_space = Staff_symbol_referencer::staff_space (me); + scale_drul (&pos, staff_space); - FIXME: clean me up. - */ -Molecule -Beam::stem_beams (Grob*me,Item *here, Item *next, Item *prev) -{ - // ugh -> use commonx - if ((next && ! (next->relative_coordinate (0, X_AXIS) > here->relative_coordinate (0, X_AXIS))) || - (prev && ! (prev->relative_coordinate (0, X_AXIS) < here->relative_coordinate (0, X_AXIS)))) - programming_error ("Beams are not left-to-right"); - - Real staffline_f = me->paper_l ()->get_var ("stafflinethickness"); - int multiplicity = get_multiplicity (me); - - SCM space_proc = me->get_grob_property ("space-function"); - SCM space = gh_call1 (space_proc, gh_int2scm (multiplicity)); - - Real thick = gh_scm2double (me->get_grob_property ("thickness")) ; - Real interbeam_f = gh_scm2double (space) ; - - Real bdy = interbeam_f; - Real stemdx = staffline_f; - - // ugh -> use commonx - Real dx = visible_stem_count (me) ? - last_visible_stem (me)->relative_coordinate (0, X_AXIS) - first_visible_stem (me)->relative_coordinate (0, X_AXIS) - : 0.0; - Real dy = gh_scm2double (me->get_grob_property ("dy")); - Real dydx = dy && dx ? dy/dx : 0; - - Molecule leftbeams; - Molecule rightbeams; - - Real nw_f; - if (!Stem::first_head (here)) - nw_f = 0; - else { - int t = Stem::type_i (here); - - SCM proc = me->get_grob_property ("flag-width-function"); - SCM result = gh_call1 (proc, gh_int2scm (t)); - nw_f = gh_scm2double (result); - } - - - Direction dir = Directional_element_interface::get (me); - - /* half beams extending to the left. */ - if (prev) + bool gap = false; + Real thick = 0.0; + if (scm_is_number (me->get_property ("gap-count")) + &&scm_to_int (me->get_property ("gap-count"))) { - int lhalfs= lhalfs = Stem::beam_count (here,LEFT) - Stem::beam_count (prev,RIGHT); - int lwholebeams= Stem::beam_count (here,LEFT) relative_coordinate (0, X_AXIS) - prev->relative_coordinate (0, X_AXIS); - w = w/2 relative_coordinate (0, X_AXIS) - here->relative_coordinate (0, X_AXIS); - Molecule a = Lookup::beam (dydx, w + stemdx, thick); - a.translate_axis (- stemdx/2, X_AXIS); - int j = 0; - Real gap_f = 0; + // ugh -> use commonx + Grob *fvs = first_visible_stem (me); + Grob *lvs = last_visible_stem (me); - SCM gap = me->get_grob_property ("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 (-dir * bdy * 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::beam (dydx, w + stemdx, thick); - } + 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 (; j < rwholebeams; j++) - { - Molecule b (a); - b.translate (Offset (Stem::invisible_b (here) ? 0 : gap_f, -dir * bdy * j)); - rightbeams.add_molecule (b); - } + for (int i = 0; i < stems.size (); i++) + { + Grob *s = stems[i]; + if (Stem::is_invisible (s)) + continue; - w = w/2 get_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 (- dir * bdy * 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; } -MAKE_SCHEME_CALLBACK (Beam,brew_molecule,1); -SCM -Beam::brew_molecule (SCM smob) +void +Beam::set_beaming (Grob *me, Beaming_info_list *beaming) { - Grob * me =unsmob_grob (smob); - - Molecule mol; - if (!gh_pair_p (me->get_grob_property ("stems"))) - return SCM_EOL; - Real x0,dx; - Link_arraystems = - Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); - if (visible_stem_count (me)) - { - // ugh -> use commonx - x0 = first_visible_stem (me)->relative_coordinate (0, X_AXIS); - dx = last_visible_stem (me)->relative_coordinate (0, X_AXIS) - x0; - } - else + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + + Direction d = LEFT; + for (int i = 0; i < stems.size (); i++) { - x0 = stems[0]->relative_coordinate (0, X_AXIS); - dx = stems.top ()->relative_coordinate (0, X_AXIS) - x0; - } - - - Real dy = gh_scm2double (me->get_grob_property ("dy")); - Real dydx = dy && dx ? dy/dx : 0; - Real y = gh_scm2double (me->get_grob_property ("y")); + /* + 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; - for (int j=0; j 0)? stems[j-1] : 0; - Item * next = (j < stems.size ()-1) ? stems[j+1] :0; - - Molecule sb = stem_beams (me, i, next, prev); - Real x = i->relative_coordinate (0, X_AXIS)-x0; - sb.translate (Offset (x, x * dydx + y)); - mol.add_molecule (sb); - } - mol.translate_axis (x0 - - dynamic_cast (me)->get_bound (LEFT)->relative_coordinate (0, X_AXIS), X_AXIS); + 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 infos_.elem (i).beams_i_drul_[-d]; - return mol.smobbed_copy (); + Stem::set_beaming (st, b, d); + } + } + while (flip (&d) != LEFT); + } } int -Beam::forced_stem_count (Grob*me) +Beam::forced_stem_count (Grob *me) { - Link_arraystems = - Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); int f = 0; - for (int i=0; i < stems.size (); i++) + for (int i = 0; i < stems.size (); i++) { - Item *s = stems[i]; + Grob *s = stems[i]; - if (Stem::invisible_b (s)) + if (Stem::is_invisible (s)) continue; - if (( (int)Stem::chord_start_f (s)) - && (Stem::get_direction (s) != Stem::get_default_dir (s))) - f++; + /* 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: - use filter and standard list functions. - */ int -Beam::visible_stem_count (Grob*me) +Beam::visible_stem_count (Grob *me) { - Link_arraystems = - Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); int c = 0; for (int i = stems.size (); i--;) { - if (!Stem::invisible_b (stems[i])) - c++; + if (!Stem::is_invisible (stems[i])) + c++; } return c; } -Item* -Beam::first_visible_stem (Grob*me) +Grob * +Beam::first_visible_stem (Grob *me) { - Link_arraystems = - Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); - + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + for (int i = 0; i < stems.size (); i++) { - if (!Stem::invisible_b (stems[i])) - return stems[i]; + if (!Stem::is_invisible (stems[i])) + return stems[i]; } return 0; } -Item* -Beam::last_visible_stem (Grob*me) +Grob * +Beam::last_visible_stem (Grob *me) { - Link_arraystems = - Pointer_group_interface__extract_elements (me, (Item*) 0, "stems"); + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); for (int i = stems.size (); i--;) { - if (!Stem::invisible_b (stems[i])) - return stems[i]; + if (!Stem::is_invisible (stems[i])) + return stems[i]; } 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 () + + rest -> stem -> beam -> interpolate_y_position () */ -MAKE_SCHEME_CALLBACK (Beam,rest_collision_callback,2); +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); - + Axis a = (Axis) scm_to_int (axis); + + if (scm_is_number (rest->get_property ("staff-position"))) + return scm_int2num (0); + assert (a == Y_AXIS); - Grob * st = unsmob_grob (rest->get_grob_property ("stem")); - Grob * stem = st; + Grob *st = unsmob_grob (rest->get_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); - - // make callback for rest from this. - Real beam_dy = 0; - Real beam_y = 0; - - - // todo: make sure this calced already. - SCM s = beam->get_grob_property ("dy"); - if (gh_number_p (s)) - beam_dy = gh_scm2double (s); - - s = beam->get_grob_property ("y"); - if (gh_number_p (s)) - beam_y = gh_scm2double (s); - + return scm_make_real (0.0); + Grob *beam = unsmob_grob (stem->get_property ("beam")); + if (!beam + || !Beam::has_interface (beam) + || !Beam::visible_stem_count (beam)) + return scm_make_real (0.0); + + Drul_array 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; - Real dydx = beam_dy && dx ? beam_dy/dx : 0; + Real slope = dy && dx ? dy / dx : 0; Direction d = Stem::get_direction (stem); - Real beamy = (stem->relative_coordinate (0, X_AXIS) - x0) * dydx + beam_y; + Real stem_y = pos[LEFT] + (stem->relative_coordinate (0, X_AXIS) - x0) * slope; + + Real beam_translation = get_beam_translation (beam); + Real beam_thickness = Beam::get_thickness (beam); - Real staff_space = Staff_symbol_referencer::staff_space (rest); + /* + TODO: this is not strictly correct for 16th knee beams. + */ + int beam_count + = Stem::beam_multiplicity (stem).length () + 1; - - Real rest_dim = rest->extent (rest, Y_AXIS)[d]*2.0 / staff_space ; // refp?? + Real height_of_my_beams = beam_thickness / 2 + + (beam_count - 1) * beam_translation; + Real beam_y = stem_y - d * height_of_my_beams; - Real minimum_dist - = gh_scm2double (rest->get_grob_property ("minimum-beam-collision-distance")); - Real dist = - minimum_dist + -d * (beamy - rest_dim) >? 0; + Grob *common_y = rest->common_refpoint (beam, Y_AXIS); - int stafflines = Staff_symbol_referencer::line_count (rest); + Real rest_dim = rest->extent (common_y, Y_AXIS)[d]; + Real minimum_distance + = + staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0) + + robust_scm2double (rest->get_property ("minimum-distance"), 0.0)); - // move discretely by half spaces. - int discrete_dist = int (ceil (dist)); + Real shift = d * (((beam_y - d * minimum_distance) - rest_dim) * d 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 scm_make_real (staff_space * shift); +} bool -Beam::has_interface (Grob*me) +Beam::is_knee (Grob *me) +{ + SCM k = me->get_property ("knee"); + if (scm_is_bool (k)) + return ly_scm2bool (k); + + bool knee = false; + int d = 0; + for (SCM s = me->get_property ("stems"); scm_is_pair (s); s = scm_cdr (s)) + { + Direction dir = get_grob_direction (unsmob_grob (scm_car (s))); + if (d && d != dir) + { + knee = true; + break; + } + d = dir; + } + + me->set_property ("knee", ly_bool2scm (knee)); + + return knee; +} + +int +Beam::get_direction_beam_count (Grob *me, Direction d) { - return me->has_interface (ly_symbol2scm ("beam-interface")); + Link_array stems + = extract_grob_array (me, ly_symbol2scm ("stems")); + int bc = 0; + + for (int i = stems.size (); i--;) + { + /* + Should we take invisible stems into account? + */ + if (Stem::get_direction (stems[i]) == d) + bc = 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"); +