X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fslur.cc;h=5f95e5d4d659203dbee12d58aa7d59c3aa69dd47;hb=fd1ca52ad6472f4eb07dacfdc25472e97ca6a170;hp=a18495ba91970c0a0247eff46ed2ffe004a48875;hpb=7f63ca8841e0b01988e34cdc24665160f1ffffcd;p=lilypond.git diff --git a/lily/slur.cc b/lily/slur.cc index a18495ba91..5f95e5d4d6 100644 --- a/lily/slur.cc +++ b/lily/slur.cc @@ -1,183 +1,576 @@ /* - slur.cc -- implement external interface for Slur + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter - - (c) 1996--2004 Han-Wen Nienhuys + Copyright (C) 1996--2015 Han-Wen Nienhuys Jan Nieuwenhuizen -*/ + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. -#include + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ +#include "slur.hh" +#include "grob-info.hh" +#include "grob-array.hh" +#include "beam.hh" #include "bezier.hh" -#include "new-slur.hh" -#include "main.hh" -#include "font-interface.hh" -#include "text-item.hh" #include "directional-element-interface.hh" -#include "group-interface.hh" -#include "lily-guile.hh" +#include "font-interface.hh" +#include "item.hh" +#include "pointer-group-interface.hh" #include "lookup.hh" +#include "main.hh" // DEBUG_SLUR_SCORING #include "note-column.hh" #include "output-def.hh" -#include "rod.hh" +#include "skyline-pair.hh" #include "spanner.hh" #include "staff-symbol-referencer.hh" -#include "staff-symbol.hh" #include "stem.hh" -#include "stencil.hh" +#include "text-interface.hh" +#include "tie.hh" #include "warn.hh" -#include "beam.hh" +#include "slur-scoring.hh" +#include "separation-item.hh" +#include "unpure-pure-container.hh" +#include "international.hh" -MAKE_SCHEME_CALLBACK (New_slur, height, 2); +MAKE_SCHEME_CALLBACK (Slur, calc_direction, 1) SCM -New_slur::height (SCM smob, SCM ax) +Slur::calc_direction (SCM smob) { - Axis a = (Axis)ly_scm2int (ax); - Grob *me = unsmob_grob (smob); - assert (a == Y_AXIS); - - SCM mol = me->get_uncached_stencil (); - Interval ext; - if (Stencil *m = unsmob_stencil (mol)) - ext = m->extent (a); - return ly_interval2scm (ext); + Grob *me = unsmob (smob); + extract_grob_set (me, "note-columns", encompasses); + + if (encompasses.empty ()) + { + me->suicide (); + return SCM_BOOL_F; + } + + Direction d = DOWN; + for (vsize i = 0; i < encompasses.size (); i++) + { + if (Note_column::dir (encompasses[i]) < 0) + { + d = UP; + break; + } + } + return scm_from_int (d); } -/* - Ugh should have dash-length + dash-period -*/ -MAKE_SCHEME_CALLBACK (New_slur, print,1); +MAKE_SCHEME_CALLBACK (Slur, pure_height, 3); +SCM +Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm) +{ + /* + Note that this estimation uses a rote add-on of 0.5 to the + highest encompassed note-head for a slur estimate. This is, + in most cases, shorter than the actual slur. + + Ways to improve this could include: + -- adding extra height for scripts that avoid slurs on the inside + -- adding extra height for the "bulge" in a slur above a note head + */ + Grob *me = unsmob (smob); + int start = scm_to_int (start_scm); + int end = scm_to_int (end_scm); + Direction dir = get_grob_direction (me); + + extract_grob_set (me, "note-columns", encompasses); + Interval ret; + ret.set_empty (); + + Grob *parent = me->get_parent (Y_AXIS); + Drul_array extremal_heights (infinity_f, -infinity_f); + 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 ()); + + for (vsize i = 0; i < encompasses.size (); i++) + { + Interval d = encompasses[i]->pure_y_extent (parent, start, end); + if (!d.is_empty ()) + { + for (DOWN_and_UP (downup)) + ret.add_point (d[dir]); + + if (extremal_heights[LEFT] == infinity_f) + extremal_heights[LEFT] = d[dir]; + extremal_heights[RIGHT] = d[dir]; + } + } + + if (ret.is_empty ()) + return ly_interval2scm (Interval ()); + + Interval extremal_span; + extremal_span.set_empty (); + for (LEFT_and_RIGHT (d)) + extremal_span.add_point (extremal_heights[d]); + ret[-dir] = minmax (dir, extremal_span[-dir], ret[-dir]); + + /* + The +0.5 comes from the fact that we try to place a slur + 0.5 staff spaces from the note-head. + (see Slur_score_state.get_base_attachments ()) + */ + ret += 0.5 * dir; + return ly_interval2scm (ret); +} + +MAKE_SCHEME_CALLBACK (Slur, height, 1); +SCM +Slur::height (SCM smob) +{ + Grob *me = unsmob (smob); + + // FIXME uncached + Stencil *m = me->get_stencil (); + return m ? ly_interval2scm (m->extent (Y_AXIS)) + : ly_interval2scm (Interval ()); +} + +MAKE_SCHEME_CALLBACK (Slur, print, 1); SCM -New_slur::print (SCM smob) +Slur::print (SCM smob) { - Grob *me = unsmob_grob (smob); - if (!scm_ilength (me->get_property ("note-columns"))) + Grob *me = unsmob (smob); + extract_grob_set (me, "note-columns", encompasses); + if (encompasses.empty ()) { me->suicide (); return SCM_EOL; } - Real base_thick = robust_scm2double (me->get_property ("thickness"), 1); - Real thick = base_thick * Staff_symbol_referencer::line_thickness (me); + 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); - Real ss = Staff_symbol_referencer::staff_space (me); Bezier one = get_curve (me); - Stencil a; - /* - TODO: replace dashed with generic property. - */ - SCM d = me->get_property ("dashed"); - if (ly_c_number_p (d)) - a = Lookup::dashed_slur (one, thick, thick * robust_scm2double (d, 0)); - else - a = Lookup::slur (one, get_grob_direction (me) * base_thick * ss / 10.0, - thick); - -#if DEBUG_SLUR_QUANTING - SCM quant_score = me->get_property ("quant-score"); + SCM dash_definition = me->get_property ("dash-definition"); + a = Lookup::slur (one, + get_grob_direction (me) * base_thick, + line_thick, + dash_definition); - if (to_boolean (me->get_paper () - ->lookup_variable (ly_symbol2scm ("debug-slur-quanting"))) - && ly_c_string_p (quant_score)) +#if DEBUG_SLUR_SCORING + SCM annotation = me->get_property ("annotation"); + if (scm_is_string (annotation)) { - String str; + string str; SCM properties = Font_interface::text_font_alist_chain (me); - Stencil tm = *unsmob_stencil (Text_item::interpret_markup - (me->get_paper ()->self_scm (), properties, - quant_score)); - a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0); + 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 (Text_interface::interpret_markup + (me->layout ()->self_scm (), properties, + annotation)); + a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0); } #endif return a.smobbed_copy (); } +/* + it would be better to do this at engraver level, but that is + fragile, as the breakable items are generated on staff level, at + which point slur starts and ends have to be tracked +*/ +void +Slur::replace_breakable_encompass_objects (Grob *me) +{ + extract_grob_set (me, "encompass-objects", extra_objects); + vector new_encompasses; + + for (vsize i = 0; i < extra_objects.size (); i++) + { + Grob *g = extra_objects[i]; + + if (has_interface (g)) + { + extract_grob_set (g, "elements", breakables); + for (vsize j = 0; j < breakables.size (); j++) + /* if we encompass a separation-item that spans multiple staves, + we filter out the grobs that don't belong to our staff */ + if (me->common_refpoint (breakables[j], Y_AXIS) == me->get_parent (Y_AXIS) + && scm_is_eq (breakables[j]->get_property ("avoid-slur"), + ly_symbol2scm ("inside"))) + new_encompasses.push_back (breakables[j]); + } + else + new_encompasses.push_back (g); + } + + if (Grob_array *a = unsmob (me->get_object ("encompass-objects"))) + a->set_array (new_encompasses); +} Bezier -New_slur::get_curve (Grob*me) +Slur::get_curve (Grob *me) { Bezier b; int i = 0; - for (SCM s = me->get_property ("control-points"); s != SCM_EOL; - s = ly_cdr (s)) - b.control_[i++] = ly_scm2offset (ly_car (s)); + 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 b; } void -New_slur::add_column (Grob*me, Grob*n) +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)); + add_bound_item (dynamic_cast (me), n); } - void -New_slur::add_extra_encompass (Grob*me, Grob*n) +Slur::add_extra_encompass (Grob *me, Grob *n) { Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n); } +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, pure_outside_slur_callback, 4, 1, ""); +SCM +Slur::pure_outside_slur_callback (SCM grob, SCM start_scm, SCM end_scm, SCM offset_scm) +{ + int start = robust_scm2int (start_scm, 0); + int end = robust_scm2int (end_scm, 0); + Grob *script = unsmob (grob); + Grob *slur = unsmob (script->get_object ("slur")); + if (!slur) + return offset_scm; + SCM avoid = script->get_property ("avoid-slur"); + if (!scm_is_eq (avoid, ly_symbol2scm ("outside")) + && !scm_is_eq (avoid, ly_symbol2scm ("around"))) + return offset_scm; -MAKE_SCHEME_CALLBACK (New_slur, outside_slur_callback, 2); + Real offset = robust_scm2double (offset_scm, 0.0); + Direction dir = get_grob_direction (script); + return scm_from_double (offset + dir * slur->pure_y_extent (slur, start, end).length () / 4); +} + +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1, ""); SCM -New_slur::outside_slur_callback (SCM grob, SCM axis) +Slur::outside_slur_callback (SCM grob, SCM offset_scm) { - Grob *script = unsmob_grob (grob); - Axis a = Axis (ly_scm2int (axis)); - assert (a == Y_AXIS); - - Grob *slur = unsmob_grob (script->get_property ("slur")); + Grob *script = unsmob (grob); + Grob *slur = unsmob (script->get_object ("slur")); if (!slur) - return scm_from_int (0); - + return offset_scm; + + SCM avoid = script->get_property ("avoid-slur"); + if (!scm_is_eq (avoid, ly_symbol2scm ("outside")) + && !scm_is_eq (avoid, ly_symbol2scm ("around"))) + return offset_scm; + + Direction dir = get_grob_direction (script); + if (dir == CENTER) + return offset_scm; + Grob *cx = script->common_refpoint (slur, X_AXIS); Grob *cy = script->common_refpoint (slur, Y_AXIS); - Bezier curve = New_slur::get_curve (slur); + Bezier curve = Slur::get_curve (slur); curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS), - slur->relative_coordinate (cy, Y_AXIS))); + slur->relative_coordinate (cy, Y_AXIS))); Interval yext = robust_relative_extent (script, cy, Y_AXIS); Interval xext = robust_relative_extent (script, cx, X_AXIS); + Interval slur_wid (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]); + + /* + cannot use is_empty because some 0-extent scripts + come up with TabStaffs. + */ + if (xext.length () <= 0 || yext.length () <= 0) + return offset_scm; + + bool contains = false; + for (LEFT_and_RIGHT (d)) + contains |= slur_wid.contains (xext[d]); + if (!contains) + return offset_scm; - Real slur_padding = 0.2; // todo: slur property, script property? + Real offset = robust_scm2double (offset_scm, 0); + yext.translate (offset); + + /* FIXME: slur property, script property? */ + Real slur_padding = robust_scm2double (script->get_property ("slur-padding"), + 0.0); yext.widen (slur_padding); - - Interval bezext (curve.control_[0][X_AXIS], - curve.control_[3][X_AXIS]); - - Real x = xext.center (); - if (!bezext.contains (xext[RIGHT])) - x = xext[LEFT]; - else if (!bezext.contains (xext[LEFT])) - x = xext[RIGHT]; - - - if (!bezext.contains (x)) - return scm_make_real (0); - - Real y = curve.get_other_coordinate (X_AXIS, x); - if (yext.contains (y)) + + Interval exts[] = {xext, yext}; + bool do_shift = false; + Real EPS = 1.0e-5; + if (scm_is_eq (avoid, ly_symbol2scm ("outside"))) + { + for (LEFT_and_RIGHT (d)) + { + Real x = minmax (-d, xext[d], curve.control_[d == LEFT ? 0 : 3][X_AXIS] + -d * EPS); + Real y = curve.get_other_coordinate (X_AXIS, x); + do_shift = y == minmax (dir, yext[-dir], y); + if (do_shift) + break; + } + } + else { - Direction dir = get_grob_direction (script); - return scm_make_real (y - yext[-dir] + dir * slur_padding); + for (int a = X_AXIS; a < NO_AXES; a++) + { + for (LEFT_and_RIGHT (d)) + { + vector coords = curve.get_other_coordinates (Axis (a), exts[a][d]); + for (vsize i = 0; i < coords.size (); i++) + { + do_shift = exts[(a + 1) % NO_AXES].contains (coords[i]); + if (do_shift) + break; + } + if (do_shift) + break; + } + if (do_shift) + break; + } } - return scm_make_real (0.0); + + Real avoidance_offset = do_shift ? curve.minmax (X_AXIS, max (xext[LEFT], curve.control_[0][X_AXIS] + EPS), min (xext[RIGHT], curve.control_[3][X_AXIS] - EPS), dir) - yext[-dir] : 0.0; + + return scm_from_double (offset + avoidance_offset); +} + +MAKE_SCHEME_CALLBACK (Slur, vertical_skylines, 1); +SCM +Slur::vertical_skylines (SCM smob) +{ + Grob *me = unsmob (smob); + vector boxes; + + if (!me) + return Skyline_pair (boxes, X_AXIS).smobbed_copy (); + + Bezier curve = Slur::get_curve (me); + vsize box_count = robust_scm2vsize (me->get_property ("skyline-quantizing"), 10); + for (vsize i = 0; i < box_count; i++) + { + Box b; + b.add_point (curve.curve_point (i * 1.0 / box_count)); + b.add_point (curve.curve_point ((i + 1) * 1.0 / box_count)); + boxes.push_back (b); + } + + return Skyline_pair (boxes, X_AXIS).smobbed_copy (); } +/* + * Used by Slur_engraver:: and Phrasing_slur_engraver:: + */ +void +Slur::auxiliary_acknowledge_extra_object (Grob_info const &info, + vector &slurs, + vector &end_slurs) +{ + if (slurs.empty () && end_slurs.empty ()) + return; + + Grob *e = info.grob (); + SCM avoid = e->get_property ("avoid-slur"); + Grob *slur; + if (end_slurs.size () && !slurs.size ()) + slur = end_slurs[0]; + else + slur = slurs[0]; + + if (has_interface (e) + || scm_is_eq (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); + if (slur) + e->set_object ("slur", slur->self_scm ()); + } + else if (scm_is_eq (avoid, ly_symbol2scm ("outside")) + || scm_is_eq (avoid, ly_symbol2scm ("around"))) + { + if (slur) + { + chain_offset_callback (e, + Unpure_pure_container::make_smob (outside_slur_callback_proc, + pure_outside_slur_callback_proc), + Y_AXIS); + chain_callback (e, outside_slur_cross_staff_proc, ly_symbol2scm ("cross-staff")); + e->set_object ("slur", slur->self_scm ()); + } + } + else if (!scm_is_eq (avoid, ly_symbol2scm ("ignore"))) + e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?", + e->name ().c_str ())); +} + +/* + A callback that will be chained together with the original cross-staff + value of a grob that is placed 'outside or 'around a slur. This just says + that any grob becomes cross-staff if it is placed 'outside or 'around a + cross-staff slur. +*/ +MAKE_SCHEME_CALLBACK (Slur, outside_slur_cross_staff, 2) +SCM +Slur::outside_slur_cross_staff (SCM smob, SCM previous) +{ + if (to_boolean (previous)) + return previous; + + Grob *me = unsmob (smob); + Grob *slur = unsmob (me->get_object ("slur")); + + if (!slur) + return SCM_BOOL_F; + return slur->get_property ("cross-staff"); +} + +MAKE_SCHEME_CALLBACK (Slur, calc_cross_staff, 1) +SCM +Slur::calc_cross_staff (SCM smob) +{ + Grob *me = unsmob (smob); + + extract_grob_set (me, "note-columns", cols); + extract_grob_set (me, "encompass-objects", extras); + + for (vsize i = 0; i < cols.size (); i++) + { + if (Grob *s = Note_column::get_stem (cols[i])) + if (to_boolean (s->get_property ("cross-staff"))) + return SCM_BOOL_T; + } + + /* the separation items are dealt with in replace_breakable_encompass_objects + so we can ignore them here */ + vector non_sep_extras; + for (vsize i = 0; i < extras.size (); i++) + if (!has_interface (extras[i])) + non_sep_extras.push_back (extras[i]); + + Grob *common = common_refpoint_of_array (cols, me, Y_AXIS); + common = common_refpoint_of_array (non_sep_extras, common, Y_AXIS); + + return scm_from_bool (common != me->get_parent (Y_AXIS)); +} -ADD_INTERFACE (New_slur, "new-slur-interface", - "A slur", - "excentricity encompass-objects control-points dashed slur-details direction height-limit note-columns ratio thickness"); +ADD_INTERFACE (Slur, + "A slur." + "\n" + "The following properties may be set in the @code{details}" + " list.\n" + "\n" + "@table @code\n" + "@item region-size\n" + "Size of region (in staff spaces) for determining" + " potential endpoints in the Y direction.\n" + "@item head-encompass-penalty\n" + "Demerit to apply when note heads collide with a slur.\n" + "@item stem-encompass-penalty\n" + "Demerit to apply when stems collide with a slur.\n" + "@item edge-attraction-factor\n" + "Factor used to calculate the demerit for distances" + " between slur endpoints and their corresponding base" + " attachments.\n" + "@item same-slope-penalty\n" + "Demerit for slurs with attachment points that are" + " horizontally aligned.\n" + "@item steeper-slope-factor\n" + "Factor used to calculate demerit only if this slur is" + " not broken.\n" + "@item non-horizontal-penalty\n" + "Demerit for slurs with attachment points that are not" + " horizontally aligned.\n" + "@item max-slope\n" + "The maximum slope allowed for this slur.\n" + "@item max-slope-factor\n" + "Factor that calculates demerit based on the max slope.\n" + "@item free-head-distance\n" + "The amount of vertical free space that must exist" + " between a slur and note heads.\n" + "@item absolute-closeness-measure\n" + "Factor to calculate demerit for variance between a note" + " head and slur.\n" + "@item extra-object-collision-penalty\n" + "Factor to calculate demerit for extra objects that the" + " slur encompasses, including accidentals, fingerings, and" + " tuplet numbers.\n" + "@item accidental-collision\n" + "Factor to calculate demerit for @code{Accidental} objects" + " that the slur encompasses. This property value replaces" + " the value of @code{extra-object-collision-penalty}.\n" + "@item extra-encompass-free-distance\n" + "The amount of vertical free space that must exist" + " between a slur and various objects it encompasses," + " including accidentals, fingerings, and tuplet numbers.\n" + "@item extra-encompass-collision-distance\n" + "This detail is currently unused.\n" + "@item head-slur-distance-factor\n" + "Factor to calculate demerit for variance between a note" + " head and slur.\n" + "@item head-slur-distance-max-ratio\n" + "The maximum value for the ratio of distance between a" + " note head and slur.\n" + "@item gap-to-staffline-inside\n" + "Minimum gap inside the curve of the slur" + " where the slur is parallel to a staffline.\n" + "@item gap-to-staffline-outside\n" + "Minimum gap outside the curve of the slur" + " where the slur is parallel to a staffline.\n" + "@item free-slur-distance\n" + "The amount of vertical free space that must exist" + " between adjacent slurs. This subproperty only works" + " for @code{PhrasingSlur}.\n" + "@item edge-slope-exponent\n" + "Factor used to calculate the demerit for the slope of" + " a slur near its endpoints; a larger value yields a" + " larger demerit.\n" + "@end table\n", + + /* properties */ + "annotation " + "avoid-slur " /* UGH. */ + "control-points " + "dash-definition " + "details " + "direction " + "eccentricity " + "encompass-objects " + "height-limit " + "inspect-quants " + "inspect-index " + "line-thickness " + "note-columns " + "positions " + "ratio " + "thickness " + );