X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstem.cc;h=7a63f20b7c5eeb0e5d6a8f023f11ca07faadc34e;hb=c5f04d22f8ad2b8735c6cfec69b8138f185752af;hp=cd20c2397e38331f4b4b8ed5fc58fb0cb1d37428;hpb=524e370fdaac2c95a82e207d74523ac3b6ed43f0;p=lilypond.git diff --git a/lily/stem.cc b/lily/stem.cc index cd20c2397e..7a63f20b7c 100644 --- a/lily/stem.cc +++ b/lily/stem.cc @@ -3,19 +3,23 @@ source file of the GNU LilyPond music typesetter - (c) 1996--2002 Han-Wen Nienhuys + (c) 1996--2003 Han-Wen Nienhuys Jan Nieuwenhuizen TODO: This is way too hairy + + TODO: fix naming. + + Stem-end, chord-start, etc. is all confusing naming. */ -#include // m_pi +#include // rint #include "lookup.hh" #include "directional-element-interface.hh" #include "note-head.hh" #include "stem.hh" -#include "debug.hh" +#include "warn.hh" #include "paper-def.hh" #include "rhythmic-head.hh" #include "font-interface.hh" @@ -31,28 +35,25 @@ #include "dot-column.hh" void -Stem::set_beaming (Grob*me ,int i, Direction d) +Stem::set_beaming (Grob*me, int beam_count, Direction d) { SCM pair = me->get_grob_property ("beaming"); if (!gh_pair_p (pair)) { - pair = gh_cons (gh_int2scm (-1),gh_int2scm (-1)); - me-> set_grob_property ("beaming", pair); + pair = gh_cons (SCM_EOL, SCM_EOL); + me->set_grob_property ("beaming", pair); } - index_set_cell (pair, d, gh_int2scm (i)); -} -int -Stem::beam_count (Grob*me,Direction d) -{ - SCM p=me->get_grob_property ("beaming"); - if (gh_pair_p (p)) - return gh_scm2int (index_cell (p,d)); - else - return -1; + SCM l = index_get_cell (pair, d); + for( int i = 0; i< beam_count; i++) + { + l = gh_cons (gh_int2scm (i), l); + } + index_set_cell (pair, d, l); } + Interval Stem::head_positions (Grob*me) { @@ -64,13 +65,13 @@ Stem::head_positions (Grob*me) Drul_array e (extremal_heads (me)); - return Interval (Staff_symbol_referencer::position_f (e[DOWN]), - Staff_symbol_referencer::position_f (e[UP])); + return Interval (Staff_symbol_referencer::get_position (e[DOWN]), + Staff_symbol_referencer::get_position (e[UP])); } Real -Stem::chord_start_f (Grob*me) +Stem::chord_start_y (Grob*me) { return head_positions (me)[get_direction (me)] * Staff_symbol_referencer::staff_space (me)/2.0; @@ -119,15 +120,12 @@ Stem::set_stemend (Grob*me, Real se) me->set_grob_property ("stem-end-position", gh_double2scm (se)); } -int -Stem::type_i (Grob*me) -{ - return first_head (me) ? Rhythmic_head::balltype_i (first_head (me)) : 2; -} /* Note head that determines hshift for upstems - */ + + WARNING: triggers direction +*/ Grob* Stem::support_head (Grob*me) { @@ -156,7 +154,9 @@ Stem::head_count (Grob*me) /* The note head which forms one end of the stem. - */ + + WARNING: triggers direction +*/ Grob* Stem::first_head (Grob*me) { @@ -166,6 +166,18 @@ Stem::first_head (Grob*me) return extremal_heads (me)[-d]; } +/* + The note head opposite to the first head. + */ +Grob* +Stem::last_head (Grob*me) +{ + Direction d = get_direction (me); + if (!d) + return 0; + return extremal_heads (me)[d]; +} + /* START is part where stem reaches `last' head. */ @@ -185,7 +197,7 @@ Stem::extremal_heads (Grob*me) Grob * n = unsmob_grob (ly_car (s)); - int p = int (Staff_symbol_referencer::position_f (n)); + int p = int (Staff_symbol_referencer::get_position (n)); Direction d = LEFT; do { @@ -213,7 +225,7 @@ Stem::note_head_positions (Grob *me) for (SCM s = me->get_grob_property ("note-heads"); gh_pair_p (s); s = ly_cdr (s)) { Grob * n = unsmob_grob (ly_car (s)); - int p = int (Staff_symbol_referencer::position_f (n)); + int p = int (Staff_symbol_referencer::get_position (n)); ps.push (p); } @@ -238,7 +250,8 @@ Stem::add_head (Grob*me, Grob *n) bool Stem::invisible_b (Grob*me) { - return ! (head_count (me) && Rhythmic_head::balltype_i (support_head (me)) >= 1); + return ! (head_count (me) + && gh_scm2int (me->get_grob_property ("duration-log")) >= 1); } Direction @@ -263,11 +276,20 @@ Stem::get_default_dir (Grob*me) Real Stem::get_default_stem_end_position (Grob*me) { + /* Tab notation feature: make stem end extend out of staff. */ + SCM up_to_staff = me->get_grob_property ("up-to-staff"); + if (to_boolean (up_to_staff)) + { + int line_count = Staff_symbol_referencer::line_count (me); + Direction dir = get_direction (me); + return dir * (line_count + 3.5); + } + bool grace_b = to_boolean (me->get_grob_property ("grace")); SCM s; Array a; - Real length_f = 0.; + Real length_f = 3.5; SCM scm_len = me->get_grob_property ("length"); if (gh_number_p (scm_len)) { @@ -276,27 +298,22 @@ Stem::get_default_stem_end_position (Grob*me) else { s = me->get_grob_property ("lengths"); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); - - // stem uses half-spaces - length_f = a[ ((duration_log (me) - 2) >? 0) get_grob_property ("stem-shorten"); - for (SCM q = s; gh_pair_p (q); q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); - - - // stem uses half-spaces - - // fixme: use scm_list_n_ref () iso. array[] - Real shorten_f = a[ ((duration_log (me) - 2) >? 0) get_grob_property ("stem-shorten"); + if (gh_pair_p (sshorten)) + { + shorten_f = 2* gh_scm2double (robust_list_ref ((duration_log (me) - 2) >? 0, sshorten)); + } /* On boundary: shorten only half */ - if (abs (chord_start_f (me)) == 0.5) + if (abs (chord_start_y (me)) == 0.5) shorten_f *= 0.5; /* URGURGURG @@ -311,13 +328,17 @@ Stem::get_default_stem_end_position (Grob*me) /* stems in unnatural (forced) direction should be shortened, according to [Roush & Gourlay] */ - if (chord_start_f (me) + if (chord_start_y (me) && (get_direction (me) != get_default_dir (me))) length_f -= shorten_f; Interval hp = head_positions (me); Real st = hp[dir] + dir * length_f; + + /* + TODO: change name to extend-stems to staff/center/'() + */ bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend")); if (!grace_b && !no_extend_b && dir * st < 0) // junkme? st = 0.0; @@ -328,16 +349,16 @@ Stem::get_default_stem_end_position (Grob*me) good typesetting practice. */ - if (!beam_l (me) && dir == UP + if (!get_beam (me) && dir == UP && duration_log (me) > 2) { Grob * closest_to_flag = extremal_heads (me)[dir]; Grob * dots = closest_to_flag - ? Rhythmic_head::dots_l (closest_to_flag ) : 0; + ? Rhythmic_head::get_dots (closest_to_flag ) : 0; if (dots) { - Real dp = Staff_symbol_referencer::position_f (dots); + Real dp = Staff_symbol_referencer::get_position (dots); Real flagy = flag (me).extent (Y_AXIS)[-dir] * 2 / Staff_symbol_referencer::staff_space (me); @@ -397,10 +418,8 @@ Stem::position_noteheads (Grob*me) bool invisible = invisible_b (me); - Real thick = 0.0; - if (invisible) - thick = gh_scm2double (me->get_grob_property ("thickness")) - * me->paper_l ()->get_var ("linethickness"); + Real thick = gh_scm2double (me->get_grob_property ("thickness")) + * me->get_paper ()->get_var ("linethickness"); Grob *hed = support_head (me); @@ -412,10 +431,10 @@ Stem::position_noteheads (Grob*me) } bool parity= true; // todo: make me settable. - int lastpos = int (Staff_symbol_referencer::position_f (heads[0])); + int lastpos = int (Staff_symbol_referencer::get_position (heads[0])); for (int i=1; i < heads.size (); i ++) { - Real p = Staff_symbol_referencer::position_f (heads[i]); + Real p = Staff_symbol_referencer::get_position (heads[i]); int dy =abs (lastpos- (int)p); if (dy <= 1) @@ -425,10 +444,16 @@ Stem::position_noteheads (Grob*me) Real l = Note_head::head_extent (heads[i], X_AXIS).length (); Direction d = get_direction (me); - heads[i]->translate_axis (l * d, X_AXIS); + /* reversed head should be shifted l-thickness, but this looks + too crowded, so we only shift l-0.5*thickness. + Notice that this leads to assymetry: Normal heads overlap + the stem 100% whereas reversed heads only overlaps the stem + 50% */ + #define magic 0.5 + heads[i]->translate_axis ((l-thick*magic) * d, X_AXIS); if (invisible_b(me)) - heads[i]->translate_axis (-thick *2* d , X_AXIS); + heads[i]->translate_axis (-thick*(2-magic) * d , X_AXIS); /* TODO: @@ -472,7 +497,7 @@ Stem::before_line_breaking (SCM smob) } else { - me->remove_grob_property ("molecule-callback"); + me->set_grob_property ("molecule-callback", SCM_EOL); } return SCM_UNSPECIFIED; @@ -495,6 +520,12 @@ Stem::height (SCM smob, SCM ax) Interval iv; if (mol != SCM_EOL) iv = unsmob_molecule (mol)->extent (a); + if (Grob *b =get_beam (me)) + { + Direction d = get_direction (me); + iv[d] += d * Beam::get_thickness (b) /2.0 ; + } + return ly_interval2scm (iv); } @@ -502,29 +533,26 @@ Stem::height (SCM smob, SCM ax) Molecule Stem::flag (Grob*me) { - /* TODO: rename flag-style into something more appropriate, - e.g. "stroke-style", maybe with values "" (i.e. no stroke), - "single" and "double". Needs more discussion. - */ - String style, fstyle, staffline_offs; - SCM fst = me->get_grob_property ("flag-style"); - if (gh_string_p (fst)) + /* 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_grob_property ("flag-style"); + if (gh_symbol_p (flag_style_scm)) { - fstyle = ly_scm2string (fst); + flag_style = ly_symbol2string (flag_style_scm); } - SCM st = me->get_grob_property ("style"); - if (gh_symbol_p (st)) - { - style = (ly_scm2string (scm_symbol_to_string (st))); - } - else + if (flag_style == "no-flag") { - style = ""; + return Molecule (); } + bool adjust = to_boolean (me->get_grob_property ("adjust-if-on-staffline")); - if (String::compare_i (style, "mensural") == 0) + String staffline_offs; + if (String::compare (flag_style, "mensural") == 0) /* 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, @@ -558,10 +586,9 @@ Stem::flag (Grob*me) --hwn. */ - Grob *first = first_head(me); - int sz = Staff_symbol_referencer::line_count (me)-1; - int p = (int)rint (Staff_symbol_referencer::position_f (first)); - staffline_offs = (((p ^ sz) & 0x1) == 0) ? "1" : "0"; + int p = (int)rint (Staff_symbol_referencer::get_position (first_head (me))); + staffline_offs = Staff_symbol_referencer::on_staffline (me, p) ? + "1" : "0"; } else { @@ -572,14 +599,37 @@ Stem::flag (Grob*me) { staffline_offs = ""; } - char c = (get_direction (me) == UP) ? 'u' : 'd'; - String index_str - = String ("flags-") + style + to_str (c) + staffline_offs + to_str (duration_log (me)); - Molecule m - = Font_interface::get_default_font (me)->find_by_name (index_str); - if (!fstyle.empty_b ()) - m.add_molecule (Font_interface::get_default_font (me)->find_by_name (String ("flags-") + to_str (c) + fstyle)); - return m; + + char dir = (get_direction (me) == UP) ? 'u' : 'd'; + String font_char = + flag_style + to_string (dir) + staffline_offs + to_string (duration_log (me)); + Font_metric *fm = Font_interface::get_default_font (me); + Molecule flag = fm->find_by_name ("flags-" + font_char); + if (flag.empty_b ()) + { + me->warning (_f ("flag `%s' not found", font_char)); + } + + SCM stroke_style_scm = me->get_grob_property ("stroke-style"); + if (gh_string_p (stroke_style_scm)) + { + String stroke_style = ly_scm2string (stroke_style_scm); + if (!stroke_style.empty_b ()) + { + String font_char = to_string (dir) + stroke_style; + Molecule stroke = fm->find_by_name ("flags-" + font_char); + if (stroke.empty_b ()) + { + me->warning (_f ("flag stroke `%s' not found", font_char)); + } + else + { + flag.add_molecule (stroke); + } + } + } + + return flag; } MAKE_SCHEME_CALLBACK (Stem,dim_callback,2); @@ -611,7 +661,32 @@ Stem::brew_molecule (SCM smob) Direction d = get_direction (me); - Real y1 = Staff_symbol_referencer::position_f (first_head (me)); + + Real y1; + + /* + This is required to avoid stems passing in tablature chords... + */ + + + /* + TODO: make the stem start a direction ? + */ + if (to_boolean (me->get_grob_property ("avoid-note-head"))) + { + Grob * lh = last_head (me); + if (!lh) + return SCM_EOL; + y1 = Staff_symbol_referencer::get_position (lh); + } + else + { + Grob * lh = first_head (me); + if (!lh) + return SCM_EOL; + y1 = Staff_symbol_referencer::get_position (lh); + } + Real y2 = stem_end_position (me); Interval stem_y (y1 ? y1); @@ -636,14 +711,14 @@ Stem::brew_molecule (SCM smob) { Real stem_width = gh_scm2double (me->get_grob_property ("thickness")) // URG - * me->paper_l ()->get_var ("linethickness"); + * me->get_paper ()->get_var ("linethickness"); Molecule ss =Lookup::filledbox (Box (Interval (-stem_width/2, stem_width/2), Interval (stem_y[DOWN]*dy, stem_y[UP]*dy))); mol.add_molecule (ss); } - if (!beam_l (me) && abs (duration_log (me)) > 2) + if (!get_beam (me) && abs (duration_log (me)) > 2) { Molecule fl = flag (me); fl.translate_axis (stem_y[d]*dy, Y_AXIS); @@ -664,7 +739,7 @@ Stem::off_callback (SCM element_smob, SCM) Real r=0; - if (invisible_b (me)) + if (head_count (me) == 0) { return gh_double2scm (0.0); } @@ -673,8 +748,15 @@ Stem::off_callback (SCM element_smob, SCM) { Interval head_wid = Note_head::head_extent(f, X_AXIS); - Real attach = - Note_head::stem_attachment_coordinate(f, X_AXIS); + + Real attach =0.0; + + if (invisible_b (me)) + { + attach = 0.0; + } + else + attach = Note_head::stem_attachment_coordinate(f, X_AXIS); Direction d = get_direction (me); @@ -689,7 +771,7 @@ Stem::off_callback (SCM element_smob, SCM) { Real rule_thick = gh_scm2double (me->get_grob_property ("thickness")) - * me->paper_l ()->get_var ("linethickness"); + * me->get_paper ()->get_var ("linethickness"); r += - d * rule_thick * 0.5; @@ -698,150 +780,175 @@ Stem::off_callback (SCM element_smob, SCM) return gh_double2scm (r); } - - Grob* -Stem::beam_l (Grob*me) +Stem::get_beam (Grob*me) { SCM b= me->get_grob_property ("beam"); return unsmob_grob (b); } - -// ugh still very long. Stem_info -Stem::calc_stem_info (Grob*me) +Stem::get_stem_info (Grob *me) { + /* Return cached info if available */ SCM scm_info = me->get_grob_property ("stem-info"); - - if (gh_pair_p (scm_info )) + if (!gh_pair_p (scm_info)) { - Stem_info si ; - - si.ideal_y = gh_scm2double (gh_car (scm_info)); - si.max_y = gh_scm2double (gh_cadr (scm_info)); - si.min_y = gh_scm2double (gh_caddr (scm_info)); - - return si; + calc_stem_info (me); + scm_info = me->get_grob_property ("stem-info"); } - - Grob * beam = beam_l (me); + + Stem_info si; + si.dir_ = Directional_element_interface::get (me); + si.ideal_y_ = gh_scm2double (gh_car (scm_info)); + si.shortest_y_ = gh_scm2double (gh_cadr (scm_info)); + return si; +} - Direction beam_dir = Directional_element_interface::get (beam); - if (!beam_dir) - { - programming_error ("Beam dir not set."); - beam_dir = UP; +void +Stem::calc_stem_info (Grob *me) +{ + /* Tab notation feature: make stem end extend out of staff. */ + SCM up_to_staff = me->get_grob_property ("up-to-staff"); + if (to_boolean (up_to_staff)) + { + int line_count = Staff_symbol_referencer::line_count (me); + Direction dir = get_direction (me); + Real ideal_y = dir * (line_count + 1.5); + Real shortest_y = ideal_y; + + me->set_grob_property ("stem-info", + scm_list_n (gh_double2scm (ideal_y), + gh_double2scm (shortest_y), + SCM_UNDEFINED)); + return; } - + Direction my_dir = Directional_element_interface::get (me); Real staff_space = Staff_symbol_referencer::staff_space (me); - Real half_space = staff_space / 2; - - int multiplicity = Beam::get_multiplicity (beam); - Real interbeam_f = Beam::get_interbeam (beam); + Grob *beam = get_beam (me); + Real beam_translation = Beam::get_beam_translation (beam); + Real beam_thickness = gh_scm2double (beam->get_grob_property ("thickness")); + int beam_count = Beam::get_direction_beam_count (beam, my_dir); - Real thick = gh_scm2double (beam->get_grob_property ("thickness")); - Stem_info info; - info.ideal_y = chord_start_f (me); - // for simplicity, we calculate as if dir == UP - info.ideal_y *= beam_dir; - SCM grace_prop = me->get_grob_property ("grace"); + /* Simple standard stem length */ + Real ideal_length = + gh_scm2double (robust_list_ref + (beam_count - 1, + me->get_grob_property ("beamed-lengths"))) + * staff_space + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; - bool grace_b = to_boolean (grace_prop); - Array a; - SCM s; + /* Condition: sane minimum free stem length (chord to beams) */ + Real ideal_minimum_free = + gh_scm2double (robust_list_ref + (beam_count - 1, + me->get_grob_property ("beamed-minimum-free-lengths"))) + * staff_space; - s = me->get_grob_property ("beamed-minimum-lengths"); - a.clear (); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); + /* UGH + It seems that also for ideal minimum length, we must use + the maximum beam count (for this direction): + + \score{ \notes\relative c''{ [a8 a32] }} + + must be horizontal. */ + Real height_of_my_beams = beam_thickness + + (beam_count - 1) * beam_translation; - Real minimum_length = a[multiplicity get_grob_property ("beamed-lengths"); + Real ideal_minimum_length = ideal_minimum_free + + height_of_my_beams + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; - a.clear (); - for (SCM q = s; q != SCM_EOL; q = ly_cdr (q)) - a.push (gh_scm2double (ly_car (q))); + ideal_length = ideal_length >? ideal_minimum_length; - Real stem_length = a[multiplicity get_grob_property ("no-stem-extend")); - if (!grace_b && !no_extend_b) - { - /* highest beam of (UP) beam must never be lower than middle - staffline - lowest beam of (UP) beam must never be lower than second staffline - */ - info.min_y = - info.min_y >? 0 - >? (- 2 * half_space - thick - + (multiplicity > 0) * thick - + interbeam_f * (multiplicity - 1)); - } - } - else - /* knee */ + Obviously not for grace beams. + + Also, not for knees. Seems to be a good thing. */ + SCM grace = me->get_grob_property ("grace"); + bool grace_b = to_boolean (grace); + bool no_extend_b = to_boolean (me->get_grob_property ("no-stem-extend")); + bool knee_b = to_boolean (beam->get_grob_property ("knee")); + if (!grace_b && !no_extend_b && !knee_b) { - info.ideal_y -= thick; - info.max_y = info.ideal_y; - info.min_y = - 1000 ; // INT_MAX; - - info.ideal_y -= stem_length; - info.max_y -= minimum_length; + /* Highest beam of (UP) beam must never be lower than middle + staffline */ + ideal_y = ideal_y >? 0; + /* Lowest beam of (UP) beam must never be lower than second staffline */ + ideal_y = ideal_y >? (-staff_space + - beam_thickness + height_of_my_beams); } - - info.ideal_y = (info.max_y ? info.min_y; - s = beam->get_grob_property ("shorten"); - if (gh_number_p (s)) - info.ideal_y -= gh_scm2double (s); - Grob *common = me->common_refpoint (beam, Y_AXIS); - Real interstaff_f = beam_dir * - (me->relative_coordinate (common, Y_AXIS) - - beam->relative_coordinate (common, Y_AXIS)); - - info.ideal_y += interstaff_f; - info.min_y += interstaff_f; - info.max_y += interstaff_f ; + SCM shorten = beam->get_grob_property ("shorten"); + if (gh_number_p (shorten)) + ideal_y -= gh_scm2double (shorten); + + + Real minimum_free = + gh_scm2double (robust_list_ref + (beam_count - 1, + me->get_grob_property + ("beamed-extreme-minimum-free-lengths"))) + * staff_space; + Real minimum_length = minimum_free + + height_of_my_beams + /* stem only extends to center of beam */ + - 0.5 * beam_thickness; + + Real minimum_y = note_start + minimum_length; + + + ideal_y *= my_dir; + Real shortest_y = minimum_y * my_dir; + me->set_grob_property ("stem-info", - scm_list_n (gh_double2scm (info.ideal_y), - gh_double2scm (info.max_y), - gh_double2scm (info.min_y), + scm_list_n (gh_double2scm (ideal_y), + gh_double2scm (shortest_y), SCM_UNDEFINED)); - - return info; } +Slice +Stem::beam_multiplicity (Grob *stem) +{ + SCM beaming= stem->get_grob_property ("beaming"); + Slice l = int_list_to_slice (gh_car (beaming)); + Slice r = int_list_to_slice (gh_cdr (beaming)); + l.unite (r); + + return l; +} + + ADD_INTERFACE (Stem,"stem-interface", "A stem", - "adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length style no-stem-extend flag-style dir-forced"); + "french-beaming up-to-staff avoid-note-head adjust-if-on-staffline thickness stem-info beamed-lengths beamed-minimum-free-lengths beamed-extreme-minimum-free-lengths lengths beam stem-shorten duration-log beaming neutral-direction stem-end-position support-head note-heads direction length flag-style no-stem-extend stroke-style"); +