X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fslur.cc;h=bdf75392418e40f7c6029052853fcc16847e1169;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=8d69ddb2c275775abdd8e28288fd84d711a12473;hpb=42392675026a0d14bda19d0a279a6762e4e84cf4;p=lilypond.git diff --git a/lily/slur.cc b/lily/slur.cc index 8d69ddb2c2..22c24b76b2 100644 --- a/lily/slur.cc +++ b/lily/slur.cc @@ -1,697 +1,579 @@ /* - slur.cc -- implement Slur + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1996--2015 Han-Wen Nienhuys + Jan Nieuwenhuizen - (c) 1996--2003 Han-Wen Nienhuys - Jan Nieuwenhuizen -*/ - -/* - [TODO] - - * should avoid stafflines with horizontal part. + 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. - * begin and end should be treated as a/acknowledge Scripts. + 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. - * smart changing of endings - - * smart changing of (Y-?)offsets to avoid ugly beziers - (along-side-stem) - - */ + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ -#include "directional-element-interface.hh" -#include "group-interface.hh" #include "slur.hh" +#include "grob-info.hh" +#include "grob-array.hh" +#include "beam.hh" +#include "bezier.hh" +#include "directional-element-interface.hh" +#include "font-interface.hh" +#include "item.hh" +#include "pointer-group-interface.hh" #include "lookup.hh" -#include "paper-def.hh" +#include "main.hh" // DEBUG_SLUR_SCORING #include "note-column.hh" +#include "output-def.hh" +#include "skyline-pair.hh" +#include "spanner.hh" +#include "staff-symbol-referencer.hh" #include "stem.hh" -#include "paper-column.hh" -#include "molecule.hh" +#include "text-interface.hh" +#include "tie.hh" #include "warn.hh" -#include "slur-bezier-bow.hh" -#include "main.hh" -#include "group-interface.hh" -#include "staff-symbol-referencer.hh" -#include "spanner.hh" - - -void -Slur::set_interface (Grob*me) -{ - /* Copy to mutable list. */ - me->set_grob_property ("attachment", - ly_deep_copy (me->get_grob_property ("attachment"))); -} +#include "slur-scoring.hh" +#include "separation-item.hh" +#include "unpure-pure-container.hh" +#include "international.hh" -void -Slur::add_column (Grob*me, Grob*n) +MAKE_SCHEME_CALLBACK (Slur, calc_direction, 1) +SCM +Slur::calc_direction (SCM smob) { - Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n); - me->add_dependency (n); - - add_bound_item (dynamic_cast (me), dynamic_cast (n)); -} + Grob *me = Grob::unsmob (smob); + extract_grob_set (me, "note-columns", encompasses); -void -Slur::de_uglyfy (Grob*me, Slur_bezier_bow* bb, Real default_height) -{ - Real length = bb->curve_.control_[3][X_AXIS] ; - Real ff = bb->fit_factor (); - for (int i = 1; i < 3; i++) + if (encompasses.empty ()) { - 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; - SCM up = me->get_grob_property ("de-uglify-parameters"); - - Real c1 = gh_scm2double (ly_car (up)); - Real c2 = gh_scm2double (ly_cadr (up)); - Real c3 = gh_scm2double (ly_caddr (up)); - - 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; - } - - bb->curve_.assert_sanity (); -} - - + me->suicide (); + return SCM_BOOL_F; + } -Direction -Slur::get_default_dir (Grob*me) -{ - Link_array encompasses = - Pointer_group_interface__extract_grobs (me, (Grob*)0, "note-columns"); - Direction d = DOWN; - for (int i=0; i < encompasses.size (); i ++) + for (vsize i = 0; i < encompasses.size (); i++) { - if (Note_column::dir (encompasses[i]) < 0) - { - d = UP; - break; - } + if (Note_column::dir (encompasses[i]) < 0) + { + d = UP; + break; + } } - return d; + return scm_from_int (d); } - -MAKE_SCHEME_CALLBACK (Slur, after_line_breaking,1); +MAKE_SCHEME_CALLBACK (Slur, pure_height, 3); SCM -Slur::after_line_breaking (SCM smob) +Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm) { - Grob *me = unsmob_grob (smob); - if (!scm_ilength (me->get_grob_property ("note-columns"))) - { - me->suicide (); - return SCM_UNSPECIFIED; - } - set_extremities (me); - if (!gh_pair_p (me->get_grob_property ("control-points"))) - set_control_points (me); - return SCM_UNSPECIFIED; -} + /* + 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 = Grob::unsmob (smob); + int start = scm_to_int (start_scm); + int end = scm_to_int (end_scm); + Direction dir = get_grob_direction (me); -void -Slur::check_slope (Grob *me) -{ - /* - Avoid too steep slurs. - */ - SCM s = me->get_grob_property ("slope-limit"); - if (gh_number_p (s)) - { - Array encompass = get_encompass_offsets (me); - Drul_array attachment; - attachment[LEFT] = encompass[0]; - attachment[RIGHT] = encompass.top (); - - Real dx = attachment[RIGHT][X_AXIS] - attachment[LEFT][X_AXIS]; - Real dy = attachment[RIGHT][Y_AXIS] - attachment[LEFT][Y_AXIS]; - if (!dx) - return; - - Real slope = slope = abs (dy / dx); - - Real limit = gh_scm2double (s); - - if (slope > limit) - { - Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me); - Direction dir = (Direction)gh_scm2int (me->get_grob_property ("direction")); - Direction d = (Direction) (- dir * (sign (dy))); - SCM a = me->get_grob_property ("attachment-offset"); - Drul_array o; - o[LEFT] = ly_scm2offset (index_get_cell (a, LEFT)); - o[RIGHT] = ly_scm2offset (index_get_cell (a, RIGHT)); - o[d][Y_AXIS] -= (limit - slope) * dx * dir / staff_space; - - o[d][Y_AXIS] *= get_grob_direction (me); - - me->set_grob_property ("attachment-offset", - gh_cons (ly_offset2scm (o[LEFT]), - ly_offset2scm (o[RIGHT]))); - } - } + 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 ()); -/* - Set 'attachment grob property, and return it. -*/ -SCM -Slur::set_extremities (Grob *me) -{ - if (!get_grob_direction (me)) - set_grob_direction (me, get_default_dir (me)); - - SCM att = me->get_grob_property ("attachment"); - /* - */ - if (!gh_pair_p (att)) - { - programming_error ("attachment is not a cons?!"); - att = gh_cons (SCM_EOL, SCM_EOL); - me->set_grob_property ("attachment", att); - } - - Direction dir = LEFT; - do + for (vsize i = 0; i < encompasses.size (); i++) { - - if (!gh_symbol_p (index_get_cell (att, dir))) - { - for (SCM s = me->get_grob_property ("extremity-rules"); - s != SCM_EOL; s = ly_cdr (s)) - { - SCM r = gh_call2 (ly_caar (s), me->self_scm (), - gh_int2scm ((int)dir)); - if (r != SCM_BOOL_F) - { - index_set_cell (att, dir, - ly_cdar (s)); - break; - } - } - } + Interval d = encompasses[i]->pure_height (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]; + } } - while (flip (&dir) != LEFT); - check_slope (me); + if (ret.is_empty ()) + return ly_interval2scm (Interval ()); - return att; -} + 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); +} -Real -Slur::get_boundary_notecolumn_y (Grob *me, Direction dir) +MAKE_SCHEME_CALLBACK (Slur, height, 1); +SCM +Slur::height (SCM smob) { - SCM cols = me->get_grob_property ("note-columns"); + Grob *me = Grob::unsmob (smob); - if(!gh_pair_p (cols)) - { - programming_error ("No note-columns in slur?"); - me->suicide (); - return 0.0; - } - - if (dir == LEFT) - cols = scm_reverse(cols); - - Grob *col = unsmob_grob (ly_car (cols)); - Grob *common[] = - { - 0, - me->common_refpoint (col, Y_AXIS) - }; - Real y; - if (col == ((Spanner*)me)->get_bound (dir)) - { - y = get_attachment (me, dir, common)[Y_AXIS]; - } - else - { - y = encompass_offset (me, col, common)[Y_AXIS] - - me->relative_coordinate (common[Y_AXIS], Y_AXIS); - } - return y; + // FIXME uncached + Stencil *m = me->get_stencil (); + return m ? ly_interval2scm (m->extent (Y_AXIS)) + : ly_interval2scm (Interval ()); } -Offset -Slur::broken_trend_offset (Grob *me, Direction dir) +MAKE_SCHEME_CALLBACK (Slur, print, 1); +SCM +Slur::print (SCM smob) { - /* - A broken slur should maintain the same vertical trend - the unbroken slur would have had. - */ - Offset o; - if (Spanner *mother = dynamic_cast (me->original_)) + Grob *me = Grob::unsmob (smob); + extract_grob_set (me, "note-columns", encompasses); + if (encompasses.empty ()) { - int k = broken_spanner_index (dynamic_cast (me)); - Grob *neighbour = mother->broken_intos_[k + dir]; - if (dir == RIGHT) - neighbour->set_grob_property ("direction", - me->get_grob_property ("direction")); - Real neighbour_y = get_boundary_notecolumn_y (neighbour, dir); - Real y = get_boundary_notecolumn_y (me, -dir); - int neighbour_cols = scm_ilength (neighbour->get_grob_property ("note-columns")); - int cols = scm_ilength (me->get_grob_property ("note-columns")); - o = Offset (0, (y*neighbour_cols + neighbour_y*cols) / - (cols + neighbour_cols)); + me->suicide (); + return SCM_EOL; } - return o; -} -/* - COMMON is size-2 array with common refpoints. + 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); -UGH: this routine delivers offsets which are *not* relative to COMMON. + Bezier one = get_curve (me); + Stencil a; -UGH, we should take COMMON-Y as argument. -*/ -Offset -Slur::get_attachment (Grob *me, Direction dir, - Grob **common) -{ - SCM s = me->get_grob_property ("attachment"); - if (!gh_pair_p (s) || !gh_symbol_p (index_get_cell (s, dir))) - { - s = set_extremities (me); - } - - SCM a = (dir == LEFT) ? ly_car (s) : ly_cdr (s); - Spanner*sp = dynamic_cast (me); - String str = ly_symbol2string (a); - - Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me); - Real hs = staff_space / 2.0; - Offset o; - - Direction slurdir = to_dir (me->get_grob_property ("direction")); - - Grob *stem = 0; - if (Note_column::has_interface (sp->get_bound (dir))) - { - Grob * n =sp->get_bound (dir); - stem = Note_column::get_stem (n); - if (stem) - { - Real x_extent; - Grob *head = Note_column::first_head (n); - if (head) - x_extent = head->extent (head, X_AXIS).length (); - else - x_extent = n->extent (n, X_AXIS).length (); - - if (!head) - { - o = Offset (0, n->extent (n, Y_AXIS)[slurdir]); - } - else if (str == "head") - { - o = Offset (0, Stem::head_positions (stem) - [slurdir] * hs); - /* - Default position is centered in X, on outer side of head Y - */ - o += Offset (0.5 * x_extent, - 0.5 * staff_space - * slurdir); - } - else if (str == "alongside-stem") - { - o = Offset (0, Stem::chord_start_y (stem)); - /* - Default position is on stem X, on outer side of head Y - */ - o += Offset (x_extent * (1 + Stem::get_direction (stem)), - 0.5 * staff_space - * slurdir); - } - else if (str == "stem") - { - o = Offset (0, Stem::stem_end_position (stem) * hs); - /* - Default position is on stem X, at stem end Y - */ - Real stem_thickness = Stem::thickness (stem); - o += Offset (0.5 * - x_extent * (1 + Stem::get_direction (stem)) - - ((dir + 1)/2) * stem_thickness - + ((1 - slurdir)/2) * stem_thickness, - 0); - } - } - } - /* - If we're not a note_column, we can't be anything but a loose-end. - But if user has set (attachment . (stem . stem)), our string is - stem, not loose-end. + SCM dash_definition = me->get_property ("dash-definition"); + a = Lookup::slur (one, + get_grob_direction (me) * base_thick, + line_thick, + dash_definition); - Hmm, maybe after-line-breaking should set this to loose-end? */ - else // if (str == "loose-end") +#if DEBUG_SLUR_SCORING + SCM annotation = me->get_property ("annotation"); + if (scm_is_string (annotation)) { - SCM other_a = dir == LEFT ? ly_cdr (s) : ly_car (s); - if (ly_symbol2string (other_a) != "loose-end") - o = broken_trend_offset (me, dir); + string str; + SCM properties = Font_interface::text_font_alist_chain (me); + + 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 = *Stencil::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 - SCM alist = me->get_grob_property ("extremity-offset-alist"); - int stemdir = stem ? Stem::get_direction (stem) : 1; - SCM l = scm_assoc - (scm_list_n (a, - gh_int2scm (stemdir * dir), - gh_int2scm (slurdir * dir), - SCM_UNDEFINED), alist); + 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; - if (l != SCM_BOOL_F) + for (vsize i = 0; i < extra_objects.size (); i++) { - Offset off = ly_scm2offset (ly_cdr (l)) * staff_space; - off[X_AXIS] *= dir; - off[Y_AXIS] *= slurdir; - o += off; + Grob *g = extra_objects[i]; + + if (Separation_item::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) + && breakables[j]->get_property ("avoid-slur") == ly_symbol2scm ("inside")) + new_encompasses.push_back (breakables[j]); + } + else + new_encompasses.push_back (g); } - /* - 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); + SCM encompass_scm = me->get_object ("encompass-objects"); + if (Grob_array::is_smob (encompass_scm)) + { + vector &arr + = Grob_array::unsmob (encompass_scm)->array_reference (); + arr = new_encompasses; } +} - Offset off = ly_scm2offset (index_get_cell (me->get_grob_property - ("attachment-offset"), - dir)) * staff_space; +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)); - off[Y_AXIS] *= slurdir; - o += off; - return o; + return b; } -Offset -Slur::encompass_offset (Grob*me, - Grob* col, - Grob **common) +void +Slur::add_column (Grob *me, Grob *n) { - Offset o; - Grob* stem = unsmob_grob (col->get_grob_property ("stem")); - - Direction dir = get_grob_direction (me); - - if (!stem) - { - programming_error ("No stem for note column?"); - 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 = get_grob_direction (stem); - o[X_AXIS] = stem->relative_coordinate (0, X_AXIS); - - /* - Simply set x to middle of notehead - */ - Real x_extent; - if (Grob *head = Note_column::first_head (col)) - x_extent = head->extent (head, X_AXIS).length (); - else - x_extent = col->extent (col, X_AXIS).length (); - o[X_AXIS] -= 0.5 * stem_dir * x_extent; + Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n); + add_bound_item (dynamic_cast (me), n); +} - if ((stem_dir == dir) - && !stem->extent (stem, Y_AXIS).is_empty ()) - { - o[Y_AXIS] = stem->extent (common[Y_AXIS], Y_AXIS)[dir]; - } - else - { - o[Y_AXIS] = col->extent (common[Y_AXIS], Y_AXIS)[dir]; - } +void +Slur::add_extra_encompass (Grob *me, Grob *n) +{ + Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n); +} - /* - leave a gap: slur mustn't touch head/stem - */ - o[Y_AXIS] += dir * robust_scm2double (me->get_grob_property ("y-free"), 0) * - 1.0; - return o; +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 = Grob::unsmob (grob); + Grob *slur = Grob::unsmob (script->get_object ("slur")); + if (!slur) + return offset_scm; + + SCM avoid = script->get_property ("avoid-slur"); + if (avoid != ly_symbol2scm ("outside") && avoid != ly_symbol2scm ("around")) + return offset_scm; + + Real offset = robust_scm2double (offset_scm, 0.0); + Direction dir = get_grob_direction (script); + return scm_from_double (offset + dir * slur->pure_height (slur, start, end).length () / 4); } -Array -Slur::get_encompass_offsets (Grob *me) +MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1, ""); +SCM +Slur::outside_slur_callback (SCM grob, SCM offset_scm) { - Spanner*sp = dynamic_cast (me); - SCM eltlist = me->get_grob_property ("note-columns"); - Grob *common[] = {common_refpoint_of_list (eltlist, me, X_AXIS), - common_refpoint_of_list (eltlist, me, Y_AXIS)}; + Grob *script = Grob::unsmob (grob); + Grob *slur = Grob::unsmob (script->get_object ("slur")); + if (!slur) + return offset_scm; - 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 encompasses = ly_scm2grobs (eltlist); - Array offsets; + SCM avoid = script->get_property ("avoid-slur"); + if (avoid != ly_symbol2scm ("outside") + && avoid != ly_symbol2scm ("around")) + return offset_scm; - Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS), - me->relative_coordinate (common[Y_AXIS], Y_AXIS)); + Direction dir = get_grob_direction (script); + if (dir == CENTER) + return offset_scm; - int first = 1; - int last = encompasses.size () - 2; + Grob *cx = script->common_refpoint (slur, X_AXIS); + Grob *cy = script->common_refpoint (slur, Y_AXIS); - offsets.push (get_attachment (me, LEFT, common)); + Bezier curve = Slur::get_curve (slur); - /* - left is broken edge - */ - if (encompasses[0] != sp->get_bound (LEFT)) - { - first--; + curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS), + slur->relative_coordinate (cy, Y_AXIS))); - // ? - offsets[0][Y_AXIS] -= - encompasses[0]->relative_coordinate (common[Y_AXIS], Y_AXIS) - - me->relative_coordinate (common[Y_AXIS], 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]); /* - right is broken edge + cannot use is_empty because some 0-extent scripts + come up with TabStaffs. */ - if (encompasses.top () != sp->get_bound (RIGHT)) - { - last++; - } + if (xext.length () <= 0 || yext.length () <= 0) + return offset_scm; - for (int i = first; i <= last; i++) - { - Offset o (encompass_offset (me, encompasses[i], common)); - offsets.push (o - origin); - } + bool contains = false; + for (LEFT_and_RIGHT (d)) + contains |= slur_wid.contains (xext[d]); - offsets.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common)); + if (!contains) + return offset_scm; - if (encompasses[0] != sp->get_bound (LEFT)) - { - offsets.top ()[Y_AXIS] -= encompasses.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS) - - me->relative_coordinate (common[Y_AXIS], Y_AXIS); - } - - return offsets; -} + 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 exts[] = {xext, yext}; + bool do_shift = false; + Real EPS = 1.0e-5; + if (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 + { + 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; + } + } + 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; -/* - ugh ? - */ -MAKE_SCHEME_CALLBACK (Slur, height, 2); -SCM -Slur::height (SCM smob, SCM ax) -{ - Axis a = (Axis)gh_scm2int (ax); - Grob * me = unsmob_grob (smob); - assert (a == Y_AXIS); - - SCM mol = me->get_uncached_molecule (); - Interval ext; - if (Molecule * m = unsmob_molecule (mol)) - ext = m->extent (a); - return ly_interval2scm (ext); + return scm_from_double (offset + avoidance_offset); } -/* - Ugh should have dash-length + dash-period - */ -MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1); +MAKE_SCHEME_CALLBACK (Slur, vertical_skylines, 1); SCM -Slur::brew_molecule (SCM smob) +Slur::vertical_skylines (SCM smob) { - Grob * me = unsmob_grob (smob); - if (!scm_ilength (me->get_grob_property ("note-columns"))) - { - me->suicide (); - return SCM_EOL; - } - - Real base_thick = robust_scm2double (me->get_grob_property ("thickness"), 1); - Real thick = base_thick * Staff_symbol_referencer::line_thickness (me); - - Real ss = Staff_symbol_referencer::staff_space (me); - Bezier one = get_curve (me); + Grob *me = Grob::unsmob (smob); + vector boxes; - // get_curve may suicide - if (!scm_ilength (me->get_grob_property ("note-columns"))) - return SCM_EOL; + if (!me) + return Skyline_pair (boxes, X_AXIS).smobbed_copy (); - Molecule a; - SCM d = me->get_grob_property ("dashed"); - if (gh_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); + 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 a.smobbed_copy (); + return Skyline_pair (boxes, X_AXIS).smobbed_copy (); } +/* + * Used by Slur_engraver:: and Phrasing_slur_engraver:: + */ void -Slur::set_control_points (Grob*me) +Slur::auxiliary_acknowledge_extra_object (Grob_info const &info, + vector &slurs, + vector &end_slurs) { - Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me); - - SCM details = me->get_grob_property ("details"); - SCM h_inf_scm = me->get_grob_property ("height-limit"); - SCM r_0_scm = me->get_grob_property ("ratio"); - - Real r_0 = robust_scm2double (r_0_scm, 1); - Real h_inf = staff_space * gh_scm2double (h_inf_scm); - - Slur_bezier_bow bb (get_encompass_offsets (me), - get_grob_direction (me), - h_inf, r_0); - + 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 (bb.fit_factor () > 1.0) + if (Tie::has_interface (e) + || avoid == ly_symbol2scm ("inside")) { - Real length = bb.curve_.control_[3][X_AXIS]; - Real default_height = slur_height (length, h_inf, r_0); - - SCM ssb = me->get_grob_property ("beautiful"); - Real sb = 0; - if (gh_number_p (ssb)) - sb = gh_scm2double (ssb); - - bb.minimise_enclosed_area (sb, details); - SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details); - Real bff = 1.0; - if (gh_pair_p (sbf) && gh_number_p (ly_cdr (sbf))) - bff = gh_scm2double (ly_cdr (sbf)); - - bb.curve_.control_[1][Y_AXIS] *= bff; - bb.curve_.control_[2][Y_AXIS] *= bff; - bb.blow_fit (); - - - Real beautiful = length * default_height * sb; - Real area = bb.get_enclosed_area (); - - /* - Slurs that fit beautifully are not ugly - */ - if (area > beautiful) - de_uglyfy (me, &bb, default_height); + 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 ()); } - - Bezier b = bb.get_bezier (); - - - SCM controls = SCM_EOL; - for (int i= 4; i--;) + else if (avoid == ly_symbol2scm ("outside") + || avoid == ly_symbol2scm ("around")) { - 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 (); - return; - } + 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 ()); + } } - - me->set_grob_property ("control-points", controls); + else if (avoid != ly_symbol2scm ("ignore")) + e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?", + e->name ().c_str ())); } - -Bezier -Slur::get_curve (Grob*me) -{ - Bezier b; - int i = 0; - SCM attach = me->get_grob_property ("attachment"); - if (!gh_pair_p (attach)) - attach = set_extremities(me); +/* + 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 (previous == SCM_BOOL_T) + return previous; - - if (!get_grob_direction (me) - || ! gh_symbol_p (index_get_cell (attach, LEFT)) - || ! gh_symbol_p (index_get_cell (attach, RIGHT))) - set_extremities (me); - - if (!gh_pair_p (me->get_grob_property ("control-points"))) - set_control_points (me); + Grob *me = Grob::unsmob (smob); + Grob *slur = Grob::unsmob (me->get_object ("slur")); - // set_control_points may suicide - if (!scm_ilength (me->get_grob_property ("note-columns"))) - return b; + if (!slur) + return SCM_BOOL_F; + return slur->get_property ("cross-staff"); +} - for (SCM s= me->get_grob_property ("control-points"); s != SCM_EOL; s = ly_cdr (s)) - { - b.control_[i] = ly_scm2offset (ly_car (s)); - i++; - } +MAKE_SCHEME_CALLBACK (Slur, calc_cross_staff, 1) +SCM +Slur::calc_cross_staff (SCM smob) +{ + Grob *me = Grob::unsmob (smob); - Array enc (get_encompass_offsets (me)); - Direction dir = get_grob_direction (me); - - Real x1 = enc[0][X_AXIS]; - Real x2 = enc.top ()[X_AXIS]; + extract_grob_set (me, "note-columns", cols); + extract_grob_set (me, "encompass-objects", extras); - Real off = 0.0; - for (int i=1; i < enc.size ()-1; i++) + for (vsize i = 0; i < cols.size (); i++) { - Real x = enc[i][X_AXIS]; - if (x > x1 && x ? dir * (enc[i][Y_AXIS] - y); - } + if (Grob *s = Note_column::get_stem (cols[i])) + if (to_boolean (s->get_property ("cross-staff"))) + return SCM_BOOL_T; } - b.translate (Offset (0, dir * off)); - return b; -} + /* 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 (!Separation_item::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 (Slur,"slur-interface", - "A slur", - "attachment attachment-offset beautiful control-points dashed details de-uglify-parameters direction extremity-rules extremity-offset-alist height-limit ratio slope-limit thickness y-free"); +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 " + );