X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fslur.cc;h=c3d7b1e2c1cc8fff4c6c3ca049787d04abb501dc;hb=73d087a6589038ac21efe802fe6d51cafa411749;hp=a2228c73ce13da30d21186a27ce28401b7a197a7;hpb=3bd3c4c9300f619f8545f3f1eaa0a5cc9c86bb14;p=lilypond.git diff --git a/lily/slur.cc b/lily/slur.cc index a2228c73ce..d8c81f7836 100644 --- a/lily/slur.cc +++ b/lily/slur.cc @@ -1,502 +1,328 @@ /* - slur.cc -- implement Slur + slur.cc -- implement external interface for Slur source file of the GNU LilyPond music typesetter - (c) 1996--2000 Han-Wen Nienhuys - Jan Nieuwenhuizen + (c) 1996--2006 Han-Wen Nienhuys + Jan Nieuwenhuizen */ -/* - [TODO] - * fix broken interstaff slurs - * begin and end should be treated as a/acknowledge Scripts. - * broken slur should have uniform trend - * smart changing of endings - * smart changing of (Y-?)offsets to avoid ugly beziers - (along-side-stem) - */ +#include "slur.hh" + +#include "beam.hh" +#include "bezier.hh" #include "directional-element-interface.hh" -#include "group-interface.hh" -#include "slur.hh" +#include "font-interface.hh" +#include "pointer-group-interface.hh" #include "lookup.hh" -#include "paper-def.hh" +#include "main.hh" // DEBUG_SLUR_SCORING #include "note-column.hh" -#include "stem.hh" -#include "paper-column.hh" -#include "molecule.hh" -#include "debug.hh" -#include "slur-bezier-bow.hh" -#include "main.hh" -#include "group-interface.hh" -#include "staff-symbol-referencer.hh" +#include "output-def.hh" #include "spanner.hh" +#include "staff-symbol-referencer.hh" +#include "staff-symbol.hh" +#include "stem.hh" +#include "text-interface.hh" +#include "tie.hh" +#include "warn.hh" +#include "slur-scoring.hh" +#include "script-interface.hh" -void -Slur::set_interface (Score_element*me) -{ - me->set_elt_property ("attachment", gh_cons (SCM_BOOL_F, SCM_BOOL_F)); - me->set_interface (ly_symbol2scm ("slur-interface")); -} - -void -Slur::add_column (Score_element*me, Score_element*n) -{ - if (!gh_pair_p (n->get_elt_property ("note-heads"))) - warning (_ ("Putting slur over rest. Ignoring.")); - else - { - Pointer_group_interface (me, "note-columns").add_element (n); - me->add_dependency (n); - } - add_bound_item (dynamic_cast (me), dynamic_cast(n)); -} -void -Slur::de_uglyfy (Score_element*me, Slur_bezier_bow* bb, Real default_height) +MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1) +SCM +Slur::calc_direction (SCM smob) { - Real length = bb->curve_.control_[3][X_AXIS] ; - Real ff = bb->fit_factor (); - for (int i = 1; i < 3; i++) - { - Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS] - - bb->curve_.control_[i][X_AXIS]) / length; - Real h = bb->curve_.control_[i][Y_AXIS] * ff / length; - - Real f = default_height / length; - Real c1 = me->paper_l ()->get_var ("bezier_control1"); - Real c2 = me->paper_l ()->get_var ("bezier_control2"); - Real c3 = me->paper_l ()->get_var ("bezier_control3"); - if (h > c1 * f) - { - h = c1 * f; - } - else if (h > c2 + c3 * ind) - { - h = c2 + c3 * ind; - } - - bb->curve_.control_[i][Y_AXIS] = h * length; - } + Grob *me = unsmob_grob (smob); + extract_grob_set (me, "note-columns", encompasses); - bb->curve_.assert_sanity (); -} + if (encompasses.empty ()) + { + me->suicide (); + return SCM_BOOL_F; + } -Direction -Slur::get_default_dir (Score_element*me) -{ - Link_array encompass_arr = - Pointer_group_interface__extract_elements (me, (Score_element*)0, "note-columns"); - Direction d = DOWN; - for (int i=0; i < encompass_arr.size (); i ++) + for (vsize i = 0; i < encompasses.size (); i++) { - if (Note_column::dir (encompass_arr[i]) < 0) + if (Note_column::dir (encompasses[i]) < 0) { d = UP; break; } } - return d; + return scm_from_int (d); } - - - - -Offset -Slur::encompass_offset (Score_element*me, - Score_element* col, - Score_element **common) +MAKE_SCHEME_CALLBACK (Slur, pure_height, 3); +SCM +Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm) { - Offset o; - Score_element* stem_l = unsmob_element (col->get_elt_property ("stem")); - - Direction dir = Directional_element_interface (me).get (); - - if (!stem_l) - { - warning (_ ("Slur over rest?")); - o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS); - o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS); - return o; - } - Direction stem_dir = Directional_element_interface (stem_l).get (); - o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS); + Grob *me = unsmob_grob (smob); + int start = scm_to_int (start_scm); + int end = scm_to_int (end_scm); + Real height = robust_scm2double (me->get_property ("height-limit"), 2.0); - /* - Simply set x to middle of notehead - */ + extract_grob_set (me, "note-columns", encompasses); + Interval ret; - o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length (); + Grob *parent = me->get_parent (Y_AXIS); + if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent) + /* this could happen if, for example, we are a cross-staff slur. + in this case, we want to be ignored */ + return ly_interval2scm (Interval ()); - if ((stem_dir == dir) - && !stem_l->extent (Y_AXIS).empty_b ()) - { - o[Y_AXIS] = stem_l->relative_coordinate (common[Y_AXIS], Y_AXIS); // iuhg - o[Y_AXIS] += stem_l->extent (Y_AXIS)[dir]; - } - else + for (vsize i = 0; i < encompasses.size (); i++) { - o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS); // ugh - o[Y_AXIS] += col->extent (Y_AXIS)[dir]; + Interval d = encompasses[i]->pure_height (parent, start, end); + if (!d.is_empty ()) + ret.unite (d); } - /* - leave a gap: slur mustn't touch head/stem - */ - o[Y_AXIS] += dir * me->paper_l ()->get_var ("slur_y_free"); - return o; + ret.widen (height * 0.5); + return ly_interval2scm (ret); } -MAKE_SCHEME_CALLBACK (Slur, after_line_breaking); +MAKE_SCHEME_CALLBACK (Slur, height, 1); SCM -Slur::after_line_breaking (SCM smob) -{ - Score_element *me = unsmob_element (smob); - if (!gh_scm2int(scm_length (me->get_elt_property ("note-columns")))) - { - me->suicide (); - return SCM_UNSPECIFIED; - } - set_extremities (me); - set_control_points (me); - return SCM_UNSPECIFIED; -} - -void -Slur::set_extremities (Score_element*me) +Slur::height (SCM smob) { - if (!Directional_element_interface (me).get ()) - Directional_element_interface (me).set (get_default_dir (me)); + Grob *me = unsmob_grob (smob); - Direction dir = LEFT; - do - { - if (!gh_symbol_p (index_cell (me->get_elt_property ("attachment"), dir))) - { - - // for (SCM s = get_elt_property ("slur-extremity-rules"); s != SCM_EOL; s = gh_cdr (s)) - for (SCM s = scm_eval (ly_symbol2scm ("slur-extremity-rules")); - s != SCM_EOL; s = gh_cdr (s)) - { - SCM r = gh_call2 (gh_caar (s), me->self_scm (), - gh_int2scm ((int)dir)); - if (r != SCM_BOOL_F) - { - index_set_cell (me->get_elt_property ("attachment"), dir, - gh_cdar (s)); - break; - } - } - } - } - while (flip (&dir) != LEFT); + // FIXME uncached + Stencil *m = me->get_stencil (); + return m ? ly_interval2scm (m->extent (Y_AXIS)) + : ly_interval2scm (Interval ()); } -Offset -Slur::get_attachment (Score_element*me,Direction dir, - Score_element **common) -{ - Spanner*sp = dynamic_cast(me); - SCM s = me->get_elt_property ("attachment"); - SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s); - String str = ly_symbol2string (a); - Real ss = Staff_symbol_referencer::staff_space ((Score_element*)me); - Real hs = ss / 2.0; - Offset o; - - Score_element *stem = 0; - if (Note_column::has_interface (sp->get_bound (dir))) - { - Score_element * n =sp->get_bound (dir); - if (Score_element *stem = Note_column::stem_l (n)) - { - - if (str == "head") - { - o = Offset (0, Stem::chord_start_f (stem)); - /* - Default position is centered in X, on outer side of head Y - */ - o += Offset (0.5 * n->extent (X_AXIS).length (), - 0.5 * ss * Directional_element_interface (me).get ()); - } - else if (str == "alongside-stem") - { - o = Offset (0, Stem::chord_start_f (stem)); - /* - Default position is on stem X, on outer side of head Y - */ - o += Offset (n->extent (X_AXIS).length () - * (1 + Stem::get_direction (stem)), - 0.5 * ss * Directional_element_interface (me).get ()); - } - else if (str == "stem") - { - o = Offset (0, Stem::stem_end_position (stem) * hs); - /* - Default position is on stem X, at stem end Y - */ - o += Offset (0.5 * - (n->extent (X_AXIS).length () - - stem->extent (X_AXIS).length ()) - * (1 + Stem::get_direction (stem)), - 0); - } - } - } - else if (str == "loose-end") - { - SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s); - if (ly_symbol2string (other_a) != "loose-end") - { - o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]); - } - } - - SCM l = scm_assoc - (scm_listify (a, - gh_int2scm (stem ? Stem::get_direction (stem) : 1 * dir), - gh_int2scm (Directional_element_interface (me).get () * dir), - SCM_UNDEFINED), - scm_eval (ly_symbol2scm ("slur-extremity-offset-alist"))); - - if (l != SCM_BOOL_F) - { - o += ly_scm2offset (gh_cdr (l)) * ss * dir; - } - - /* - What if get_bound () is not a note-column? - */ - if (str != "loose-end" - && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS]) - { - o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS) - - me->relative_coordinate (common[Y_AXIS], Y_AXIS); - } - - return o; -} - -Array -Slur::get_encompass_offset_arr (Score_element*me) +/* + Ugh should have dash-length + dash-period +*/ +MAKE_SCHEME_CALLBACK (Slur, print, 1); +SCM +Slur::print (SCM smob) { - Spanner*sp = dynamic_cast(me); - SCM eltlist = me->get_elt_property ("note-columns"); - Score_element *common[] = {me->common_refpoint (eltlist,X_AXIS), - me->common_refpoint (eltlist,Y_AXIS)}; - - - common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS); - common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS); - - Link_array encompass_arr; - while (gh_pair_p (eltlist)) + Grob *me = unsmob_grob (smob); + extract_grob_set (me, "note-columns", encompasses); + if (encompasses.empty ()) { - encompass_arr.push (unsmob_element (gh_car (eltlist))); - eltlist =gh_cdr (eltlist); + me->suicide (); + return SCM_EOL; } - encompass_arr.reverse (); - - - Array offset_arr; - - Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS), - me->relative_coordinate (common[Y_AXIS], Y_AXIS)); - int first = 1; - int last = encompass_arr.size () - 2; + Real staff_thick = Staff_symbol_referencer::line_thickness (me); + Real base_thick = staff_thick + * robust_scm2double (me->get_property ("thickness"), 1); + Real line_thick = staff_thick + * robust_scm2double (me->get_property ("line-thickness"), 1); - offset_arr.push (get_attachment (me, LEFT, common)); + Bezier one = get_curve (me); + Stencil a; /* - left is broken edge + TODO: replace dashed with generic property. */ + SCM p = me->get_property ("dash-period"); + SCM f = me->get_property ("dash-fraction"); + if (scm_is_number (p) && scm_is_number (f)) + a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0), + robust_scm2double (f, 0)); + else + a = Lookup::slur (one, + get_grob_direction (me) * base_thick, + line_thick); - if (encompass_arr[0] != sp->get_bound (LEFT)) - { - first--; - - // ? - offset_arr[0][Y_AXIS] -= - encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS) - - me->relative_coordinate (common[Y_AXIS], Y_AXIS); - } +#if DEBUG_SLUR_SCORING + SCM quant_score = me->get_property ("quant-score"); - /* - right is broken edge - */ - if (encompass_arr.top () != sp->get_bound (RIGHT)) + if (to_boolean (me->layout () + ->lookup_variable (ly_symbol2scm ("debug-slur-scoring"))) + && scm_is_string (quant_score)) { - last++; - } + string str; + SCM properties = Font_interface::text_font_alist_chain (me); - for (int i = first; i <= last; i++) - { - Offset o (encompass_offset (me, encompass_arr[i], common)); - offset_arr.push (o - origin); + + if (!scm_is_number (me->get_property ("font-size"))) + properties = scm_cons (scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-6), SCM_EOL), + properties); + + Stencil tm = *unsmob_stencil (Text_interface::interpret_markup + (me->layout ()->self_scm (), properties, + quant_score)); + a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0); } +#endif - offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common)); + return a.smobbed_copy (); +} - if (encompass_arr[0] != sp->get_bound (LEFT)) - { - offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS) - - me->relative_coordinate (common[Y_AXIS], Y_AXIS); - } +Bezier +Slur::get_curve (Grob *me) +{ + Bezier b; + int i = 0; + for (SCM s = me->get_property ("control-points"); scm_is_pair (s); + s = scm_cdr (s)) + b.control_[i++] = ly_scm2offset (scm_car (s)); - return offset_arr; + return b; } +void +Slur::add_column (Grob *me, Grob *n) +{ + Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n); + add_bound_item (dynamic_cast (me), dynamic_cast (n)); +} -MAKE_SCHEME_CALLBACK(Slur,set_spacing_rods); -SCM -Slur::set_spacing_rods (SCM smob) +void +Slur::add_extra_encompass (Grob *me, Grob *n) { - Score_element*me = unsmob_element (smob); - - Rod r; - Spanner*sp = dynamic_cast(me); - r.item_l_drul_[LEFT] = sp->get_bound (LEFT); - r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT); - r.distance_f_ = - gh_scm2double (me->get_elt_property ("minimum-length")) - * me->paper_l ()->get_var ("staffspace"); - - r.add_to_cols (); - return SCM_UNSPECIFIED; + Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n); } -/* - Ugh should have dash-length + dash-period - */ -MAKE_SCHEME_CALLBACK (Slur, brew_molecule); +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1); SCM -Slur::brew_molecule (SCM smob) +Slur::outside_slur_callback (SCM grob, SCM offset_scm) { - Score_element * me = unsmob_element (smob); - if (!gh_scm2int(scm_length (me->get_elt_property ("note-columns")))) - { - me->suicide (); - return SCM_EOL; - } - - Real thick = me->paper_l ()->get_var ("stafflinethickness") * - gh_scm2double (me->get_elt_property ("thickness")); - Bezier one = get_curve (me); - - Molecule a; - SCM d = me->get_elt_property ("dashed"); - if (gh_number_p (d)) - a = me->lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d)); - else - a = me->lookup_l ()->slur (one, Directional_element_interface (me).get () * thick, thick); + Grob *script = unsmob_grob (grob); + Grob *slur = unsmob_grob (script->get_object ("slur")); - return a.create_scheme(); -} + if (!slur) + return offset_scm; -void -Slur::set_control_points (Score_element*me) -{ - Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me); - Real h_inf = me->paper_l ()->get_var ("slur_height_limit_factor") * - staff_space; - Real r_0 = me->paper_l ()->get_var ("slur_ratio"); + SCM avoid = script->get_property ("avoid-slur"); + if (avoid != ly_symbol2scm ("outside") + && avoid != ly_symbol2scm ("around")) + return offset_scm; - Slur_bezier_bow bb (get_encompass_offset_arr (me), - Directional_element_interface (me).get (), - h_inf, r_0); + Direction dir = get_grob_direction (script); + if (dir == CENTER) + return offset_scm; - if (bb.fit_factor () > 1.0) - { - Real length = bb.curve_.control_[3][X_AXIS]; - Real default_height = slur_height (length, h_inf, r_0); - bb.minimise_enclosed_area (me->paper_l()); - - Real bff = me->paper_l ()->get_var ("slur_force_blowfit"); - bb.curve_.control_[1][Y_AXIS] *= bff; - bb.curve_.control_[2][Y_AXIS] *= bff; - bb.blow_fit (); - - Real sb = me->paper_l ()->get_var ("slur_beautiful"); - Real beautiful = length * default_height * sb; - Real area = bb.enclosed_area_f (); - - /* - Slurs that fit beautifully are not ugly - */ - if (area > beautiful) - de_uglyfy (me, &bb, default_height); - } + Grob *cx = script->common_refpoint (slur, X_AXIS); + Grob *cy = script->common_refpoint (slur, Y_AXIS); - Bezier b = bb.get_bezier (); + Bezier curve = Slur::get_curve (slur); + curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS), + slur->relative_coordinate (cy, Y_AXIS))); - SCM controls = SCM_EOL; - for (int i= 4; i--;) - { - controls = gh_cons ( ly_offset2scm (b.control_[i]), controls); - /* - BRRR WHURG. - All these null control-points, where do they all come from? - */ - if (i && b.control_[i][X_AXIS] == 0) - me->suicide (); - } + Interval yext = robust_relative_extent (script, cy, Y_AXIS); + Interval xext = robust_relative_extent (script, cx, X_AXIS); - me->set_elt_property ("control-points", controls); -} + Real offset = robust_scm2double (offset_scm, 0); + yext.translate (offset); -Bezier -Slur::get_curve (Score_element*me) -{ - Bezier b; - int i = 0; - - if (!Directional_element_interface (me).get () - || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT))) - set_extremities (me); + /* FIXME: slur property, script property? */ + Real slur_padding = robust_scm2double (script->get_property ("slur-padding"), + 0.0); + yext.widen (slur_padding); + + Real EPS = 1e-3; + Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]); + bool consider[] = { false, false, false }; + Real ys[] = {0, 0, 0}; + bool do_shift = false; - if (!gh_pair_p (me->get_elt_property ("control-points"))) - set_control_points (me); - - for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s)) + for (int d = LEFT, k = 0; d <= RIGHT; d++, k++) { - b.control_[i] = ly_scm2offset (gh_car (s)); - i++; + Real x = xext.linear_combination ((Direction) d); + consider[k] = bezext.contains (x); + + if (consider[k]) + { + ys[k] + = (fabs (bezext[LEFT] - x) < EPS) + ? curve.control_[0][Y_AXIS] + : ((fabs (bezext[RIGHT] - x) < EPS) + ? curve.control_[3][Y_AXIS] + : curve.get_other_coordinate (X_AXIS, x)); + + /* Request shift if slur is contained script's Y, or if + script is inside slur and avoid == outside. */ + if (yext.contains (ys[k]) + || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside"))) + do_shift = true; + } } - Array enc (get_encompass_offset_arr (me)); - Direction dir = Directional_element_interface (me).get (); + Real avoidance_offset = 0.0; + for (int d = LEFT, k = 0; d <= RIGHT; d++, k++) + if (consider[k]) + avoidance_offset = dir * (max (dir * avoidance_offset, + dir * (ys[k] - yext[-dir] + dir * slur_padding))); - Real x1 = enc[0][X_AXIS]; - Real x2 = enc.top ()[X_AXIS]; + return scm_from_double (offset + avoidance_offset); +} - Real off = 0.0; - for (int i=1; i < enc.size ()-1; i++) +/* + * Used by Slur_engraver:: and Phrasing_slur_engraver:: + */ +void +Slur::auxiliary_acknowledge_extra_object (Grob_info info, + vector &slurs, + vector &end_slurs) +{ + if (slurs.empty () && end_slurs.empty ()) + return; + + Grob *e = info.grob (); + SCM avoid = e->get_property ("avoid-slur"); + if (Tie::has_interface (e) + || avoid == ly_symbol2scm ("inside")) + { + for (vsize i = slurs.size (); i--;) + add_extra_encompass (slurs[i], e); + for (vsize i = end_slurs.size (); i--;) + add_extra_encompass (end_slurs[i], e); + } + else if (avoid == ly_symbol2scm ("outside") + || avoid == ly_symbol2scm ("around")) { - Real x = enc[i][X_AXIS]; - if (x > x1 && x ? dir * (enc[i][Y_AXIS] - y); + chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS); + e->set_object ("slur", slur->self_scm ()); } } - b.translate (Offset (0, dir * off)); - return b; + else + e->warning ("Ignoring grob for slur. avoid-slur not set?"); } -bool -Slur::has_interface (Score_element*me) -{ - return me->has_interface (ly_symbol2scm ("slur-interface")); -} - +ADD_INTERFACE (Slur, "slur-interface", + + "A slur", + + /* properties */ + "avoid-slur " /* UGH. */ + "control-points " + "dash-fraction " + "dash-period " + "details " + "direction " + "eccentricity " + "encompass-objects " + "height-limit " + "inspect-quants " + "inspect-index " + "line-thickness " + "note-columns " + "positions " + "quant-score " + "ratio " + "thickness " + );