X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstem.cc;h=045a90760b29d7e916f211e0c46322b99f433ea2;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=314f74e2b42108d7062c6d85238320bb283327df;hpb=89c94db7a59904e2cb7066e075049465be8ac1ac;p=lilypond.git diff --git a/lily/stem.cc b/lily/stem.cc index 314f74e2b4..045a90760b 100644 --- a/lily/stem.cc +++ b/lily/stem.cc @@ -1,7 +1,7 @@ /* This file is part of LilyPond, the GNU music typesetter. - Copyright (C) 1996--2010 Han-Wen Nienhuys + Copyright (C) 1996--2015 Han-Wen Nienhuys Jan Nieuwenhuizen TODO: This is way too hairy @@ -24,10 +24,23 @@ along with LilyPond. If not, see . */ +/* + Note that several internal functions have a calc_beam bool argument. + This argument means: "If set, acknowledge the fact that there is a beam + and deal with it. If not, give me the measurements as if there is no beam." + Most pure functions are called WITHOUT calc_beam, whereas non-pure functions + are called WITH calc_beam. + + The only exception to this is ::pure_height, which calls internal_pure_height + with "true" for calc_beam in order to trigger the calculations of other + pure heights in case there is a beam. It passes false, however, to + internal_height and internal_pure_height for all subsequent iterations. +*/ + #include "stem.hh" #include "spanner.hh" -#include // rint +#include // rint using namespace std; #include "beam.hh" @@ -65,7 +78,7 @@ Stem::set_beaming (Grob *me, int beam_count, Direction d) lst = scm_cons (scm_from_int (i), lst); else lst = SCM_BOOL_F; - + index_set_cell (pair, d, lst); } @@ -89,7 +102,7 @@ Stem::head_positions (Grob *me) { Drul_array e (extremal_heads (me)); return Interval (Staff_symbol_referencer::get_position (e[DOWN]), - Staff_symbol_referencer::get_position (e[UP])); + Staff_symbol_referencer::get_position (e[UP])); } return Interval (); } @@ -100,22 +113,56 @@ Stem::chord_start_y (Grob *me) Interval hp = head_positions (me); if (!hp.is_empty ()) return hp[get_grob_direction (me)] * Staff_symbol_referencer::staff_space (me) - * 0.5; + * 0.5; return 0; } - - void -Stem::set_stemend (Grob *me, Real se) +Stem::set_stem_positions (Grob *me, Real se) { // todo: margins Direction d = get_grob_direction (me); + Grob *beam = Grob::unsmob (me->get_object ("beam")); if (d && d * head_positions (me)[get_grob_direction (me)] >= se * d) me->warning (_ ("weird stem size, check for narrow beams")); - me->set_property ("stem-end-position", scm_from_double (se)); + // trigger note collision mechanisms + Real stem_beg = internal_calc_stem_begin_position (me, false); + Real staff_space = Staff_symbol_referencer::staff_space (me); + Real half_space = staff_space * 0.5; + + Interval height; + height[-d] = stem_beg * half_space; + height[d] = se * half_space + beam_end_corrective (me); + + Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), + 0.0); + bool stemlet = stemlet_length > 0.0; + + Grob *lh = get_reference_head (me); + + if (!lh) + { + if (stemlet && beam) + { + Real beam_translation = Beam::get_beam_translation (beam); + Real beam_thickness = Beam::get_beam_thickness (beam); + int beam_count = beam_multiplicity (me).length () + 1; + + height[-d] = (height[d] - d + * (0.5 * beam_thickness + + beam_translation * max (0, (beam_count - 1)) + + stemlet_length)); + } + else if (!stemlet && beam) + height[-d] = height[d]; + else if (stemlet && !beam) + me->programming_error ("Can't have a stemlet without a beam."); + } + + me->set_property ("stem-begin-position", scm_from_double (height[-d] * 2 / staff_space)); + me->set_property ("length", scm_from_double (height.length () * 2 / staff_space)); } /* Note head that determines hshift for upstems @@ -178,32 +225,35 @@ Stem::extremal_heads (Grob *me) Grob *n = heads[i]; int p = Staff_symbol_referencer::get_rounded_position (n); - Direction d = LEFT; - do - { - if (d * p > d * extpos[d]) - { - exthead[d] = n; - extpos[d] = p; - } - } - while (flip (&d) != DOWN); + for (LEFT_and_RIGHT (d)) + { + if (d * p > d * extpos[d]) + { + exthead[d] = n; + extpos[d] = p; + } + } } return exthead; } -/* The positions, in ascending order. */ +/* The staff positions, in ascending order. + * If FILTER, include the main column of noteheads only */ vector -Stem::note_head_positions (Grob *me) +Stem::note_head_positions (Grob *me, bool filter) { vector ps; extract_grob_set (me, "note-heads", heads); + Grob *xref = common_refpoint_of_array (heads, me, X_AXIS); for (vsize i = heads.size (); i--;) { Grob *n = heads[i]; - int p = Staff_symbol_referencer::get_rounded_position (n); + if (filter + && n->relative_coordinate (xref, X_AXIS) != 0.0) + continue; + int p = Staff_symbol_referencer::get_rounded_position (n); ps.push_back (p); } @@ -225,113 +275,152 @@ Stem::add_head (Grob *me, Grob *n) bool Stem::is_invisible (Grob *me) { - return !is_normal_stem (me) - && (robust_scm2double (me->get_property ("stemlet-length"), - 0.0) == 0.0); + if (is_normal_stem (me)) + return false; + else if (head_count (me)) + return true; + else // if there are no note-heads, we might want stemlets + return 0.0 == robust_scm2double (me->get_property ("stemlet-length"), 0.0); } - bool Stem::is_normal_stem (Grob *me) { - return head_count (me) && scm_to_int (me->get_property ("duration-log")) >= 1; -} + if (!head_count (me)) + return false; + return scm_to_int (me->get_property ("duration-log")) >= 1; +} MAKE_SCHEME_CALLBACK (Stem, pure_height, 3) SCM Stem::pure_height (SCM smob, - SCM /* start */, - SCM /* end */) + SCM /* start */, + SCM /* end */) { - Grob *me = unsmob_grob (smob); - Interval iv; + Grob *me = Grob::unsmob (smob); + return ly_interval2scm (internal_pure_height (me, true)); +} +Interval +Stem::internal_pure_height (Grob *me, bool calc_beam) +{ if (!is_normal_stem (me)) - return ly_interval2scm (iv); + return Interval (0.0, 0.0); - Real ss = Staff_symbol_referencer::staff_space (me); - Real rad = Staff_symbol_referencer::staff_radius (me); + Grob *beam = Grob::unsmob (me->get_object ("beam")); + + Interval iv = internal_height (me, false); - if (!to_boolean (me->get_property ("cross-staff"))) + if (!beam) + return iv; + if (calc_beam) { - Real len = scm_to_double (calc_length (smob)) * ss / 2; + Interval overshoot; Direction dir = get_grob_direction (me); + for (DOWN_and_UP (d)) + overshoot[d] = d == dir ? dir * infinity_f : iv[d]; + + vector heights; + vector my_stems; + extract_grob_set (beam, "normal-stems", normal_stems); + for (vsize i = 0; i < normal_stems.size (); i++) + if (get_grob_direction (normal_stems[i]) == dir) + { + if (normal_stems[i] != me) + heights.push_back (Stem::internal_pure_height (normal_stems[i], false)); + else + heights.push_back (iv); + my_stems.push_back (normal_stems[i]); + } + //iv.unite (heights.back ()); + // look for cross staff effects + vector coords; + Grob *common = common_refpoint_of_array (my_stems, me, Y_AXIS); + Real min_pos = infinity_f; + Real max_pos = -infinity_f; + for (vsize i = 0; i < my_stems.size (); i++) + { + coords.push_back (my_stems[i]->pure_relative_y_coordinate (common, 0, INT_MAX)); + min_pos = min (min_pos, coords[i]); + max_pos = max (max_pos, coords[i]); + } + for (vsize i = 0; i < heights.size (); i++) + { + heights[i][dir] += dir == DOWN + ? coords[i] - max_pos + : coords[i] - min_pos; + } - Interval hp = head_positions (me); - if (dir == UP) - iv = Interval (0, len); - else - iv = Interval (-len, 0); - - if (!hp.is_empty ()) - { - iv.translate (hp[dir] * ss / 2); - iv.add_point (hp[-dir] * ss / 2); - } + for (vsize i = 0; i < heights.size (); i++) iv.unite (heights[i]); - /* extend the stem (away from the head) to cover the staff */ - if (dir == UP) - iv[UP] = max (iv[UP], rad * ss); - else - iv[DOWN] = min (iv[DOWN], -rad * ss); + for (vsize i = 0; i < my_stems.size (); i++) + cache_pure_height (my_stems[i], iv, heights[i]); + iv.intersect (overshoot); } - else - iv = Interval (-rad * ss, rad * ss); - return ly_interval2scm (iv); + return iv; +} + +void +Stem::cache_pure_height (Grob *me, Interval iv, Interval my_iv) +{ + Interval overshoot; + Direction dir = get_grob_direction (me); + for (DOWN_and_UP (d)) + overshoot[d] = d == dir ? dir * infinity_f : my_iv[d]; + + iv.intersect (overshoot); + dynamic_cast (me)->cache_pure_height (iv); } MAKE_SCHEME_CALLBACK (Stem, calc_stem_end_position, 1) SCM Stem::calc_stem_end_position (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); + return scm_from_double (internal_calc_stem_end_position (me, true)); +} + +MAKE_SCHEME_CALLBACK (Stem, pure_calc_stem_end_position, 3) +SCM +Stem::pure_calc_stem_end_position (SCM smob, + SCM, /* start */ + SCM /* end */) +{ + Grob *me = Grob::unsmob (smob); + return scm_from_double (internal_calc_stem_end_position (me, false)); +} +Real +Stem::internal_calc_stem_end_position (Grob *me, bool calc_beam) +{ if (!head_count (me)) - return scm_from_double (0.0); + return 0.0; - if (Grob *beam = get_beam (me)) + Grob *beam = get_beam (me); + Real ss = Staff_symbol_referencer::staff_space (me); + Direction dir = get_grob_direction (me); + + if (beam && calc_beam) { (void) beam->get_property ("quantized-positions"); - return me->get_property ("stem-end-position"); + return robust_scm2double (me->get_property ("length"), 0.0) + + dir * robust_scm2double (me->get_property ("stem-begin-position"), 0.0); } - + vector a; /* WARNING: IN HALF SPACES */ - Real length = robust_scm2double (me->get_property ("length"), 7); - - Direction dir = get_grob_direction (me); - Interval hp = head_positions (me); - Real stem_end = dir ? hp[dir] + dir * length : 0; - - /* TODO: change name to extend-stems to staff/center/'() */ - bool no_extend = to_boolean (me->get_property ("no-stem-extend")); - if (!no_extend && dir * stem_end < 0) - stem_end = 0.0; - - return scm_from_double (stem_end); -} - -/* Length is in half-spaces (or: positions) here. */ -MAKE_SCHEME_CALLBACK (Stem, calc_length, 1) -SCM -Stem::calc_length (SCM smob) -{ - Grob *me = unsmob_grob (smob); - SCM details = me->get_property ("details"); int durlog = duration_log (me); - Real ss = Staff_symbol_referencer::staff_space (me); + Real staff_rad = Staff_symbol_referencer::staff_radius (me); Real length = 7; SCM s = ly_assoc_get (ly_symbol2scm ("lengths"), details, SCM_EOL); if (scm_is_pair (s)) length = 2 * scm_to_double (robust_list_ref (durlog - 2, s)); - Direction dir = get_grob_direction (me); - /* Stems in unnatural (forced) direction should be shortened, according to [Roush & Gourlay] */ Interval hp = head_positions (me); @@ -339,12 +428,26 @@ Stem::calc_length (SCM smob) { SCM sshorten = ly_assoc_get (ly_symbol2scm ("stem-shorten"), details, SCM_EOL); SCM scm_shorten = scm_is_pair (sshorten) - ? robust_list_ref (max (duration_log (me) - 2, 0), sshorten) : SCM_EOL; - Real shorten = 2* robust_scm2double (scm_shorten, 0); - - /* On boundary: shorten only half */ - if (abs (head_positions (me)[dir]) <= 1) - shorten *= 0.5; + ? robust_list_ref (max (duration_log (me) - 2, 0), sshorten) : SCM_EOL; + Real shorten_property = 2 * robust_scm2double (scm_shorten, 0); + /* change in length between full-size and shortened stems is executed gradually. + "transition area" = stems between full-sized and fully-shortened. + */ + Real quarter_stem_length = 2 * scm_to_double (robust_list_ref (0, s)); + /* shortening_step = difference in length between consecutive stem lengths + in transition area. The bigger the difference between full-sized + and shortened stems, the bigger shortening_step is. + (but not greater than 1/2 and not smaller than 1/4). + value 6 is heuristic; it determines the suggested transition slope steepnesas. + */ + Real shortening_step = min (max (0.25, (shorten_property / 6)), 0.5); + /* Shortening of unflagged stems should begin on the first stem that sticks + more than 1 staffspace (2 units) out of the staff. + Shortening of flagged stems begins in the same moment as unflagged ones, + but not earlier than on the middle line note. + */ + Real which_step = (min (1.0, quarter_stem_length - (2 * staff_rad) - 2.0)) + abs (hp[dir]); + Real shorten = min (max (0.0, (shortening_step * which_step)), shorten_property); length -= shorten; } @@ -352,8 +455,8 @@ Stem::calc_length (SCM smob) length *= robust_scm2double (me->get_property ("length-fraction"), 1.0); /* Tremolo stuff. */ - Grob *t_flag = unsmob_grob (me->get_object ("tremolo-flag")); - if (t_flag && !unsmob_grob (me->get_object ("beam"))) + Grob *t_flag = Grob::unsmob (me->get_object ("tremolo-flag")); + if (t_flag && (!Grob::is_smob (me->get_object ("beam")) || !calc_beam)) { /* Crude hack: add extra space if tremolo flag is there. @@ -361,7 +464,7 @@ Stem::calc_length (SCM smob) (Stem_tremolo::raw_stencil () looks at the beam.) --hwn */ Real minlen = 1.0 - + 2 * Stem_tremolo::vertical_length (t_flag) / ss; + + 2 * Stem_tremolo::vertical_length (t_flag) / ss; /* We don't want to add the whole extent of the flag because the trem and the flag can overlap partly. beam_translation gives a good @@ -380,9 +483,17 @@ Stem::calc_length (SCM smob) } length = max (length, minlen + 1.0); } - - return scm_from_double (length); + + Real stem_end = dir ? hp[dir] + dir * length : 0; + + /* TODO: change name to extend-stems to staff/center/'() */ + bool no_extend = to_boolean (me->get_property ("no-stem-extend")); + if (!no_extend && dir * stem_end < 0) + stem_end = 0.0; + + return stem_end; } + /* The log of the duration (Number of hooks on the flag minus two) */ int Stem::duration_log (Grob *me) @@ -395,14 +506,14 @@ MAKE_SCHEME_CALLBACK (Stem, calc_positioning_done, 1); SCM Stem::calc_positioning_done (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); if (!head_count (me)) return SCM_BOOL_T; me->set_property ("positioning-done", SCM_BOOL_T); - + extract_grob_set (me, "note-heads", ro_heads); - vector heads (ro_heads); + vector heads (ro_heads); vector_sort (heads, position_less); Direction dir = get_grob_direction (me); @@ -421,8 +532,8 @@ Stem::calc_positioning_done (SCM smob) bool is_harmonic_centered = false; for (vsize i = 0; i < heads.size (); i++) - is_harmonic_centered = is_harmonic_centered - || heads[i]->get_property ("style") == ly_symbol2scm ("harmonic"); + is_harmonic_centered = is_harmonic_centered + || heads[i]->get_property ("style") == ly_symbol2scm ("harmonic"); is_harmonic_centered = is_harmonic_centered && is_invisible (me); Real w = hed->extent (hed, X_AXIS)[dir]; @@ -431,65 +542,84 @@ Stem::calc_positioning_done (SCM smob) Real amount = w - heads[i]->extent (heads[i], X_AXIS)[dir]; if (is_harmonic_centered) - amount = - hed->extent (hed, X_AXIS).linear_combination (CENTER) - - heads[i]->extent (heads[i], X_AXIS).linear_combination (CENTER); - - heads[i]->translate_axis (amount, X_AXIS); + amount + = hed->extent (hed, X_AXIS).linear_combination (CENTER) + - heads[i]->extent (heads[i], X_AXIS).linear_combination (CENTER); + + if (!isnan (amount)) // empty heads can produce NaN + heads[i]->translate_axis (amount, X_AXIS); } bool parity = true; Real lastpos = Real (Staff_symbol_referencer::get_position (heads[0])); for (vsize i = 1; i < heads.size (); i++) { Real p = Staff_symbol_referencer::get_position (heads[i]); - Real dy = fabs (lastpos- p); + Real dy = fabs (lastpos - p); /* - dy should always be 0.5, 0.0, 1.0, but provide safety margin - for rounding errors. + dy should always be 0.5, 0.0, 1.0, but provide safety margin + for rounding errors. */ if (dy < 1.1) - { - if (parity) - { - Real ell = heads[i]->extent (heads[i], X_AXIS).length (); - - Direction d = get_grob_direction (me); - /* - Reversed head should be shifted ell-thickness, but this - looks too crowded, so we only shift ell-0.5*thickness. - - This leads to assymetry: Normal heads overlap the - stem 100% whereas reversed heads only overlaps the - stem 50% - */ - - Real reverse_overlap = 0.5; - heads[i]->translate_axis ((ell - thick * reverse_overlap) * d, - X_AXIS); - - if (is_invisible (me)) - heads[i]->translate_axis (-thick * (2 - reverse_overlap) * d, - X_AXIS); - - /* TODO: - - For some cases we should kern some more: when the - distance between the next or prev note is too large, we'd - get large white gaps, eg. - - | + { + if (parity) + { + Real ell = heads[i]->extent (heads[i], X_AXIS).length (); + + Direction d = get_grob_direction (me); + /* + Reversed head should be shifted ell-thickness, but this + looks too crowded, so we only shift ell-0.5*thickness. + + This leads to assymetry: Normal heads overlap the + stem 100% whereas reversed heads only overlaps the + stem 50% + */ + Real reverse_overlap = 0.5; + + /* + However, the first reverse head has to be shifted even + more than the full reverse overlap if it is the same + height as the first head or there will be a gap + because of the head slant (issue 346). + */ + + if (i == 1 && dy < 0.1) + reverse_overlap = 1.1; + + if (is_invisible (me)) + { + // Semibreves and longer are tucked in considerably + // to be recognizable as chorded rather than + // parallel voices. During the course of issue 346 + // there was a discussion to change this for unisons + // (dy < 0.1) to reduce overlap but without reaching + // agreement and with Gould being rather on the + // overlapping front. + reverse_overlap = 2; + } + + heads[i]->translate_axis ((ell - thick * reverse_overlap) * d, + X_AXIS); + + /* TODO: + + For some cases we should kern some more: when the + distance between the next or prev note is too large, we'd + get large white gaps, eg. + + | X| - |X <- kern this. - | - X - - */ - } - parity = !parity; - } + |X <- kern this. + | + X + + */ + } + parity = !parity; + } else - parity = true; + parity = true; lastpos = int (p); } @@ -501,9 +631,9 @@ MAKE_SCHEME_CALLBACK (Stem, calc_direction, 1); SCM Stem::calc_direction (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); Direction dir = CENTER; - if (Grob *beam = unsmob_grob (me->get_object ("beam"))) + if (Grob *beam = Grob::unsmob (me->get_object ("beam"))) { SCM ignore_me = beam->get_property ("direction"); (void) ignore_me; @@ -514,9 +644,9 @@ Stem::calc_direction (SCM smob) SCM dd = me->get_property ("default-direction"); dir = to_dir (dd); if (!dir) - return me->get_property ("neutral-direction"); + return me->get_property ("neutral-direction"); } - + return scm_from_int (dir); } @@ -524,7 +654,7 @@ MAKE_SCHEME_CALLBACK (Stem, calc_default_direction, 1); SCM Stem::calc_default_direction (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); Direction dir = CENTER; int staff_center = 0; @@ -533,175 +663,104 @@ Stem::calc_default_direction (SCM smob) { int udistance = (int) (UP * hp[UP] - staff_center); int ddistance = (int) (DOWN * hp[DOWN] - staff_center); - + dir = Direction (sign (ddistance - udistance)); } - + return scm_from_int (dir); } - +// note - height property necessary to trigger quantized beam positions +// otherwise, we could just use Grob::stencil_height_proc MAKE_SCHEME_CALLBACK (Stem, height, 1); SCM Stem::height (SCM smob) { - Grob *me = unsmob_grob (smob); - if (!is_normal_stem (me)) - return ly_interval2scm (Interval ()); - - Direction dir = get_grob_direction (me); - - Grob *beam = get_beam (me); - if (beam) - { - /* trigger set-stem-lengths. */ - beam->get_property ("quantized-positions"); - } + Grob *me = Grob::unsmob (smob); + return ly_interval2scm (internal_height (me, true)); +} - /* - Can't get_stencil (), since that would cache stencils too early. - This causes problems with beams. - */ - Stencil *stencil = unsmob_stencil (print (smob)); - Interval iv = stencil ? stencil->extent (Y_AXIS) : Interval (); +Grob * +Stem::get_reference_head (Grob *me) +{ + return to_boolean (me->get_property ("avoid-note-head")) + ? last_head (me) + : first_head (me); +} + +Real +Stem::beam_end_corrective (Grob *me) +{ + Grob *beam = Grob::unsmob (me->get_object ("beam")); + Direction dir = get_grob_direction (me); if (beam) { if (dir == CENTER) - { - programming_error ("no stem direction"); - dir = UP; - } - iv[dir] += dir * Beam::get_beam_thickness (beam) * 0.5; + { + programming_error ("no stem direction"); + dir = UP; + } + return dir * Beam::get_beam_thickness (beam) * 0.5; } - - return ly_interval2scm (iv); + return 0.0; } -Real -Stem::stem_end_position (Grob *me) +Interval +Stem::internal_height (Grob *me, bool calc_beam) { - return robust_scm2double (me->get_property ("stem-end-position"), 0); -} + Grob *beam = get_beam (me); + if (!is_valid_stem (me) && !beam) + return Interval (); -MAKE_SCHEME_CALLBACK (Stem, calc_flag, 1); -SCM -Stem::calc_flag (SCM smob) -{ - Grob *me = unsmob_grob (smob); + Direction dir = get_grob_direction (me); - int log = duration_log (me); - /* - TODO: maybe property stroke-style should take different values, - e.g. "" (i.e. no stroke), "single" and "double" (currently, it's - '() or "grace"). */ - string flag_style; - - SCM flag_style_scm = me->get_property ("flag-style"); - if (scm_is_symbol (flag_style_scm)) - flag_style = ly_symbol2string (flag_style_scm); - - if (flag_style == "no-flag") - return Stencil ().smobbed_copy (); - - bool adjust = true; - - string staffline_offs; - if (flag_style == "mensural") - /* Mensural notation: For notes on staff lines, use different - flags than for notes between staff lines. The idea is that - flags are always vertically aligned with the staff lines, - regardless if the note head is on a staff line or between two - staff lines. In other words, the inner end of a flag always - touches a staff line. - */ - { - if (adjust) - { - int p = (int) (rint (stem_end_position (me))); - staffline_offs - = Staff_symbol_referencer::on_line (me, p) ? "0" : "1"; - } - else - staffline_offs = "2"; - } - else - staffline_offs = ""; - - char dir = (get_grob_direction (me) == UP) ? 'u' : 'd'; - string font_char = flag_style - + to_string (dir) + staffline_offs + to_string (log); - Font_metric *fm = Font_interface::get_default_font (me); - Stencil flag = fm->find_by_name ("flags." + font_char); - if (flag.is_empty ()) - me->warning (_f ("flag `%s' not found", font_char)); - - SCM stroke_style_scm = me->get_property ("stroke-style"); - if (scm_is_string (stroke_style_scm)) + if (beam && calc_beam) { - string stroke_style = ly_scm2string (stroke_style_scm); - if (!stroke_style.empty ()) - { - string font_char = flag_style + to_string (dir) + stroke_style; - Stencil stroke = fm->find_by_name ("flags." + font_char); - if (stroke.is_empty ()) - { - font_char = to_string (dir) + stroke_style; - stroke = fm->find_by_name ("flags." + font_char); - } - if (stroke.is_empty ()) - me->warning (_f ("flag stroke `%s' not found", font_char)); - else - flag.add_stencil (stroke); - } - } + /* trigger set-stem-lengths. */ + (void) beam->get_property ("quantized-positions"); + } - return flag.smobbed_copy (); -} + /* + If there is a beam but no stem, slope calculations depend on this + routine to return where the stem end /would/ be. + */ + if (calc_beam && !beam && !Stencil::is_smob (me->get_property ("stencil"))) + return Interval (); + + Real y1 = robust_scm2double ((calc_beam + ? me->get_property ("stem-begin-position") + : me->get_pure_property ("stem-begin-position", 0, INT_MAX)), + 0.0); + + Real y2 = dir * robust_scm2double ((calc_beam + ? me->get_property ("length") + : me->get_pure_property ("length", 0, INT_MAX)), + 0.0) + + y1; + Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; -Stencil -Stem::flag (Grob *me) -{ - int log = duration_log (me); - if (log < 3 - || unsmob_grob (me->get_object ("beam"))) - return Stencil (); + Interval stem_y = Interval (min (y1, y2), max (y2, y1)) * half_space; - if (!is_normal_stem (me)) - return Stencil (); - - // This get_property call already evaluates the scheme function with - // the grob passed as argument! Thus, we only have to check if a valid - // stencil is returned. - SCM flag_style_scm = me->get_property ("flag"); - if (Stencil *flag = unsmob_stencil (flag_style_scm)) { - return *flag; - } else { - return Stencil (); - } + return stem_y; } MAKE_SCHEME_CALLBACK (Stem, width, 1); SCM Stem::width (SCM e) { - Grob *me = unsmob_grob (e); + Grob *me = Grob::unsmob (e); Interval r; if (is_invisible (me)) r.set_empty (); - else if (unsmob_grob (me->get_object ("beam")) - || abs (duration_log (me)) <= 2) + else { r = Interval (-1, 1); r *= thickness (me) / 2; } - else - { - r = Interval (-1, 1) * thickness (me) * 0.5; - r.unite (flag (me).extent (X_AXIS)); - } + return ly_interval2scm (r); } @@ -709,73 +768,122 @@ Real Stem::thickness (Grob *me) { return scm_to_double (me->get_property ("thickness")) - * Staff_symbol_referencer::line_thickness (me); + * Staff_symbol_referencer::line_thickness (me); } -MAKE_SCHEME_CALLBACK (Stem, print, 1); +MAKE_SCHEME_CALLBACK (Stem, calc_stem_begin_position, 1); SCM -Stem::print (SCM smob) +Stem::calc_stem_begin_position (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + return scm_from_double (internal_calc_stem_begin_position (me, true)); +} + +MAKE_SCHEME_CALLBACK (Stem, pure_calc_stem_begin_position, 3); +SCM +Stem::pure_calc_stem_begin_position (SCM smob, + SCM, /* start */ + SCM /* end */) +{ + Grob *me = Grob::unsmob (smob); + return scm_from_double (internal_calc_stem_begin_position (me, false)); +} + +Real +Stem::internal_calc_stem_begin_position (Grob *me, bool calc_beam) { - Grob *me = unsmob_grob (smob); Grob *beam = get_beam (me); - - Stencil mol; + Real ss = Staff_symbol_referencer::staff_space (me); + if (beam && calc_beam) + { + (void) beam->get_property ("quantized-positions"); + return robust_scm2double (me->get_property ("stem-begin-position"), 0.0); + } + Direction d = get_grob_direction (me); + Grob *lh = get_reference_head (me); - Real stemlet_length = robust_scm2double (me->get_property ("stemlet-length"), - 0.0); - bool stemlet = stemlet_length > 0.0; + if (!lh) + return 0.0; - /* TODO: make the stem start a direction ? - This is required to avoid stems passing in tablature chords. */ - Grob *lh - = to_boolean (me->get_property ("avoid-note-head")) - ? last_head (me) - : first_head (me); + Real pos = Staff_symbol_referencer::get_position (lh); - if (!lh && !stemlet) - return SCM_EOL; + if (Grob *head = support_head (me)) + { + Interval head_height = head->extent (head, Y_AXIS); + Real y_attach = Note_head::stem_attachment_coordinate (head, Y_AXIS); - if (!lh && stemlet && !beam) - return SCM_EOL; + y_attach = head_height.linear_combination (y_attach); + if (!isinf (y_attach) && !isnan (y_attach)) // empty heads + pos += d * y_attach * 2 / ss; + } - if (lh && robust_scm2int (lh->get_property ("duration-log"), 0) < 1) - return SCM_EOL; + return pos; +} - if (is_invisible (me)) - return SCM_EOL; - Real y2 = robust_scm2double (me->get_property ("stem-end-position"), 0.0); - Real y1 = y2; - Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; +MAKE_SCHEME_CALLBACK (Stem, pure_calc_length, 3); +SCM +Stem::pure_calc_length (SCM smob, SCM /*start*/, SCM /*end*/) +{ + Grob *me = Grob::unsmob (smob); + Real beg = robust_scm2double (me->get_pure_property ("stem-begin-position", 0, INT_MAX), 0.0); + Real res = fabs (internal_calc_stem_end_position (me, false) - beg); + return scm_from_double (res); +} - if (lh) - y2 = Staff_symbol_referencer::get_position (lh); - else if (stemlet) +MAKE_SCHEME_CALLBACK (Stem, calc_length, 1); +SCM +Stem::calc_length (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + if (Grob::is_smob (me->get_object ("beam"))) { - Real beam_translation = Beam::get_beam_translation (beam); - Real beam_thickness = Beam::get_beam_thickness (beam); - int beam_count = beam_multiplicity (me).length () + 1; - - y2 -= d - * (0.5 * beam_thickness - + beam_translation * max (0, (beam_count - 1)) - + stemlet_length) / half_space; + me->programming_error ("ly:stem::calc-length called but will not be used for beamed stem."); + return scm_from_double (0.0); } - Interval stem_y (min (y1, y2), max (y2, y1)); + Real beg = robust_scm2double (me->get_property ("stem-begin-position"), 0.0); + Real res = fabs (internal_calc_stem_end_position (me, true) - beg); + return scm_from_double (res); +} - if (Grob *head = support_head (me)) - { - /* - must not take ledgers into account. - */ - Interval head_height = head->extent (head, Y_AXIS); - Real y_attach = Note_head::stem_attachment_coordinate (head, Y_AXIS); +bool +Stem::is_valid_stem (Grob *me) +{ + /* TODO: make the stem start a direction ? + This is required to avoid stems passing in tablature chords. */ + if (!me) + return false; + Grob *lh = get_reference_head (me); + Grob *beam = Grob::unsmob (me->get_object ("beam")); - y_attach = head_height.linear_combination (y_attach); - stem_y[Direction (-d)] += d * y_attach / half_space; - } + if (!lh && !beam) + return false; + + if (is_invisible (me)) + return false; + + return true; +} + +MAKE_SCHEME_CALLBACK (Stem, print, 1); +SCM +Stem::print (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + if (!is_valid_stem (me)) + return SCM_EOL; + + Direction dir = get_grob_direction (me); + Real y1 = robust_scm2double (me->get_property ("stem-begin-position"), 0.0); + Real y2 = dir * robust_scm2double (me->get_property ("length"), 0.0) + y1; + + Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; + + Interval stem_y = Interval (min (y1, y2), max (y2, y1)) * half_space; + + stem_y[dir] -= beam_end_corrective (me); // URG Real stem_width = thickness (me); @@ -783,35 +891,15 @@ Stem::print (SCM smob) = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")); Box b = Box (Interval (-stem_width / 2, stem_width / 2), - Interval (stem_y[DOWN] * half_space, stem_y[UP] * half_space)); + stem_y); + Stencil mol; Stencil ss = Lookup::round_filled_box (b, blot); mol.add_stencil (ss); - mol.add_stencil (get_translated_flag (me)); - return mol.smobbed_copy (); } -Stencil -Stem::get_translated_flag (Grob *me) -{ - Stencil fl = flag (me); - if (!fl.is_empty ()) - { - Direction d = get_grob_direction (me); - Real blot - = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter")); - Real stem_width = thickness (me); - Real half_space = Staff_symbol_referencer::staff_space (me) * 0.5; - Real y2 = robust_scm2double (me->get_property ("stem-end-position"), 0.0); - fl.translate_axis (y2 * half_space - d * blot / 2, Y_AXIS); - fl.translate_axis (stem_width / 2, X_AXIS); - } - return fl; -} - - /* move the stem to right of the notehead if it is up. */ @@ -819,7 +907,7 @@ MAKE_SCHEME_CALLBACK (Stem, offset_callback, 1); SCM Stem::offset_callback (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); extract_grob_set (me, "rests", rests); if (rests.size ()) @@ -829,27 +917,29 @@ Stem::offset_callback (SCM smob) return scm_from_double (r); } - if (Grob *f = first_head (me)) { Interval head_wid = f->extent (f, X_AXIS); Real attach = 0.0; if (is_invisible (me)) - attach = 0.0; + attach = 0.0; else - attach = Note_head::stem_attachment_coordinate (f, X_AXIS); + attach = Note_head::stem_attachment_coordinate (f, X_AXIS); Direction d = get_grob_direction (me); Real real_attach = head_wid.linear_combination (d * attach); - Real r = real_attach; + Real r = isnan(real_attach)? 0.0: real_attach; /* If not centered: correct for stem thickness. */ - if (attach) - { - Real rule_thick = thickness (me); - r += -d * rule_thick * 0.5; - } + string style = robust_symbol2string (f->get_property ("style"), "default"); + if (attach && style != "mensural" + && style != "neomensural" + && style != "petrucci") + { + Real rule_thick = thickness (me); + r += -d * rule_thick * 0.5; + } return scm_from_double (r); } @@ -861,7 +951,7 @@ Spanner * Stem::get_beam (Grob *me) { SCM b = me->get_object ("beam"); - return dynamic_cast (unsmob_grob (b)); + return dynamic_cast (Grob::unsmob (b)); } Stem_info @@ -869,7 +959,7 @@ Stem::get_stem_info (Grob *me) { Stem_info si; si.dir_ = get_grob_direction (me); - + SCM scm_info = me->get_property ("stem-info"); si.ideal_y_ = scm_to_double (scm_car (scm_info)); si.shortest_y_ = scm_to_double (scm_cadr (scm_info)); @@ -880,7 +970,7 @@ MAKE_SCHEME_CALLBACK (Stem, calc_stem_info, 1); SCM Stem::calc_stem_info (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); Direction my_dir = get_grob_direction (me); if (!my_dir) @@ -896,7 +986,7 @@ Stem::calc_stem_info (SCM smob) { (void) beam->get_property ("beaming"); } - + Real beam_translation = Beam::get_beam_translation (beam); Real beam_thickness = Beam::get_beam_thickness (beam); int beam_count = Beam::get_direction_beam_count (beam, my_dir); @@ -906,40 +996,39 @@ Stem::calc_stem_info (SCM smob) /* Simple standard stem length */ SCM details = me->get_property ("details"); SCM lengths = ly_assoc_get (ly_symbol2scm ("beamed-lengths"), details, SCM_EOL); - + Real ideal_length = (scm_is_pair (lengths) ? (scm_to_double (robust_list_ref (beam_count - 1, lengths)) - * staff_space - * length_fraction - /* - stem only extends to center of beam - */ - - 0.5 * beam_thickness) + * staff_space + * length_fraction + /* + stem only extends to center of beam + */ + - 0.5 * beam_thickness) : 0.0); /* Condition: sane minimum free stem length (chord to beams) */ lengths = ly_assoc_get (ly_symbol2scm ("beamed-minimum-free-lengths"), - details, SCM_EOL); + details, SCM_EOL); Real ideal_minimum_free = (scm_is_pair (lengths) ? (scm_to_double (robust_list_ref (beam_count - 1, lengths)) - * staff_space - * length_fraction) + * staff_space + * length_fraction) : 0.0); Real height_of_my_trem = 0.0; - Grob *trem = unsmob_grob (me->get_object ("tremolo-flag")); + Grob *trem = Grob::unsmob (me->get_object ("tremolo-flag")); if (trem) { height_of_my_trem - = Stem_tremolo::vertical_length (trem) - /* hack a bit of space around the trem. */ - + beam_translation; + = Stem_tremolo::vertical_length (trem) + /* hack a bit of space around the trem. */ + + beam_translation; } - /* UGH It seems that also for ideal minimum length, we must use the maximum beam count (for this direction): @@ -948,21 +1037,21 @@ Stem::calc_stem_info (SCM smob) must be horizontal. */ Real height_of_my_beams = beam_thickness - + (beam_count - 1) * beam_translation; + + (beam_count - 1) * beam_translation; Real ideal_minimum_length = ideal_minimum_free - + height_of_my_beams - + height_of_my_trem - /* stem only extends to center of beam */ - - 0.5 * beam_thickness; + + height_of_my_beams + + height_of_my_trem + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; ideal_length = max (ideal_length, ideal_minimum_length); /* Convert to Y position, calculate for dir == UP */ Real note_start = /* staff positions */ - head_positions (me)[my_dir] * 0.5 - * my_dir * staff_space; + head_positions (me)[my_dir] * 0.5 + * my_dir * staff_space; Real ideal_y = note_start + ideal_length; /* Conditions for Y position */ @@ -981,40 +1070,40 @@ Stem::calc_stem_info (SCM smob) Also, not for knees. Seems to be a good thing. */ bool no_extend = to_boolean (me->get_property ("no-stem-extend")); - bool is_knee = to_boolean (beam->get_property ("knee")); + bool is_knee = Beam::is_knee (beam); if (!no_extend && !is_knee) { /* Highest beam of (UP) beam must never be lower than middle - staffline */ + staffline */ ideal_y = max (ideal_y, 0.0); /* Lowest beam of (UP) beam must never be lower than second staffline */ ideal_y = max (ideal_y, (-staff_space - - beam_thickness + height_of_my_beams)); + - beam_thickness + height_of_my_beams)); } ideal_y -= robust_scm2double (beam->get_property ("shorten"), 0); SCM bemfl = ly_assoc_get (ly_symbol2scm ("beamed-extreme-minimum-free-lengths"), - details, SCM_EOL); - + details, SCM_EOL); + Real minimum_free = (scm_is_pair (bemfl) ? (scm_to_double (robust_list_ref (beam_count - 1, bemfl)) - * staff_space - * length_fraction) + * staff_space + * length_fraction) : 0.0); Real minimum_length = max (minimum_free, height_of_my_trem) - + height_of_my_beams - /* stem only extends to center of beam */ - - 0.5 * beam_thickness; + + height_of_my_beams + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; ideal_y *= my_dir; Real minimum_y = note_start + minimum_length; Real shortest_y = minimum_y * my_dir; return scm_list_2 (scm_from_double (ideal_y), - scm_from_double (shortest_y)); + scm_from_double (shortest_y)); } Slice @@ -1030,7 +1119,7 @@ Stem::beam_multiplicity (Grob *stem) bool Stem::is_cross_staff (Grob *stem) { - Grob *beam = unsmob_grob (stem->get_object ("beam")); + Grob *beam = Grob::unsmob (stem->get_object ("beam")); return beam && Beam::is_cross_staff (beam); } @@ -1038,64 +1127,71 @@ MAKE_SCHEME_CALLBACK (Stem, calc_cross_staff, 1) SCM Stem::calc_cross_staff (SCM smob) { - return scm_from_bool (is_cross_staff (unsmob_grob (smob))); + return scm_from_bool (is_cross_staff (Grob::unsmob (smob))); +} + +Grob * +Stem::flag (Grob *me) +{ + return Grob::unsmob (me->get_object ("flag")); } /* FIXME: Too many properties */ ADD_INTERFACE (Stem, - "The stem represents the graphical stem. In addition, it" - " internally connects note heads, beams, and tremolos. Rests" - " and whole notes have invisible stems.\n" - "\n" - "The following properties may be set in the @code{details}" - " list.\n" - "\n" - "@table @code\n" - "@item beamed-lengths\n" - "List of stem lengths given beam multiplicity.\n" - "@item beamed-minimum-free-lengths\n" - "List of normal minimum free stem lengths (chord to beams)" - " given beam multiplicity.\n" - "@item beamed-extreme-minimum-free-lengths\n" - "List of extreme minimum free stem lengths (chord to beams)" - " given beam multiplicity.\n" - "@item lengths\n" - "Default stem lengths. The list gives a length for each" - " flag count.\n" - "@item stem-shorten\n" - "How much a stem in a forced direction should be shortened." - " The list gives an amount depending on the number of flags" - " and beams.\n" - "@end table\n", - - /* properties */ - "avoid-note-head " - "beam " - "beaming " - "beamlet-default-length " - "beamlet-max-length-proportion " - "default-direction " - "details " - "direction " - "duration-log " - "flag " - "flag-style " - "french-beaming " - "length " - "length-fraction " - "max-beam-connect " - "neutral-direction " - "no-stem-extend " - "note-heads " - "positioning-done " - "rests " - "stem-end-position " - "stem-info " - "stemlet-length " - "stroke-style " - "thickness " - "tremolo-flag " - ); + "The stem represents the graphical stem. In addition, it" + " internally connects note heads, beams, and tremolos. Rests" + " and whole notes have invisible stems.\n" + "\n" + "The following properties may be set in the @code{details}" + " list.\n" + "\n" + "@table @code\n" + "@item beamed-lengths\n" + "List of stem lengths given beam multiplicity.\n" + "@item beamed-minimum-free-lengths\n" + "List of normal minimum free stem lengths (chord to beams)" + " given beam multiplicity.\n" + "@item beamed-extreme-minimum-free-lengths\n" + "List of extreme minimum free stem lengths (chord to beams)" + " given beam multiplicity.\n" + "@item lengths\n" + "Default stem lengths. The list gives a length for each" + " flag count.\n" + "@item stem-shorten\n" + "How much a stem in a forced direction should be shortened." + " The list gives an amount depending on the number of flags" + " and beams.\n" + "@end table\n", + + /* properties */ + "avoid-note-head " + "beam " + "beaming " + "beamlet-default-length " + "beamlet-max-length-proportion " + "default-direction " + "details " + "direction " + "double-stem-separation " + "duration-log " + "flag " + "french-beaming " + "length " + "length-fraction " + "max-beam-connect " + "melody-spanner " + "neutral-direction " + "no-stem-extend " + "note-heads " + "positioning-done " + "rests " + "stem-begin-position " + "stem-info " + "stemlet-length " + "thickness " + "tremolo-flag " + "tuplet-start " + ); /****************************************************************/