/*
- 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 <hanwen@xs4all.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
- (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- Jan Nieuwenhuizen <janneke@gnu.org>
-*/
+ 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.
-/*
- [TODO]
- * should avoid stafflines with horizontal part.
- * begin and end should be treated as a/acknowledge Scripts.
- * smart changing of endings
- * smart changing of (Y-?)offsets to avoid ugly beziers
- (along-side-stem)
- */
+ 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 <http://www.gnu.org/licenses/>.
+*/
-#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 "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 "skyline-pair.hh"
#include "spanner.hh"
-
-
-void
-Slur::set_interface (Grob*me)
+#include "staff-symbol-referencer.hh"
+#include "stem.hh"
+#include "text-interface.hh"
+#include "tie.hh"
+#include "warn.hh"
+#include "slur-scoring.hh"
+#include "separation-item.hh"
+#include "unpure-pure-container.hh"
+#include "international.hh"
+
+MAKE_SCHEME_CALLBACK (Slur, calc_direction, 1)
+SCM
+Slur::calc_direction (SCM smob)
{
- /* Copy to mutable list. */
- me->set_grob_property ("attachment",
- ly_deep_copy (me->get_grob_property ("attachment")));
-}
+ Grob *me = Grob::unsmob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
-void
-Slur::add_column (Grob*me, Grob*n)
-{
- if (!gh_pair_p (n->get_grob_property ("note-heads")))
- me->warning (_ ("Putting slur over rest. Ignoring."));
- else
+ if (encompasses.empty ())
{
- Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
- me->add_dependency (n);
+ me->suicide ();
+ return SCM_BOOL_F;
}
- add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*> (n));
-}
-
-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++)
- {
- 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 ();
-}
-
-Direction
-Slur::get_default_dir (Grob*me)
-{
- Link_array<Grob> encompass_arr =
- Pointer_group_interface__extract_grobs (me, (Grob*)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)
- {
- 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")))
+ /*
+ 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);
+
+ extract_grob_set (me, "note-columns", encompasses);
+ Interval ret;
+ ret.set_empty ();
+
+ Grob *parent = me->get_parent (Y_AXIS);
+ Drul_array<Real> 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++)
{
- me->suicide ();
- return SCM_UNSPECIFIED;
+ 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];
+ }
}
- set_extremities (me);
- set_control_points (me);
- return SCM_UNSPECIFIED;
-}
+ 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]);
-void
-Slur::check_slope (Grob *me)
-{
/*
- Avoid too steep slurs.
- */
- SCM s = me->get_grob_property ("slope-limit");
- if (gh_number_p (s))
- {
- Array<Offset> encompass = get_encompass_offset_arr (me);
- Drul_array<Offset> 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<Offset> o;
- o[LEFT] = ly_scm2offset (index_cell (a, LEFT));
- o[RIGHT] = ly_scm2offset (index_cell (a, RIGHT));
- o[d][Y_AXIS] -= (limit - slope) * dx * dir / staff_space;
-
- o[d][Y_AXIS] *= Directional_element_interface::get (me);
-
- me->set_grob_property ("attachment-offset",
- gh_cons (ly_offset2scm (o[LEFT]),
- ly_offset2scm (o[RIGHT])));
- }
- }
+ 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);
}
-void
-Slur::set_extremities (Grob *me)
+MAKE_SCHEME_CALLBACK (Slur, height, 1);
+SCM
+Slur::height (SCM smob)
{
- if (!Directional_element_interface::get (me))
- Directional_element_interface::set (me, get_default_dir (me));
+ Grob *me = Grob::unsmob (smob);
- Direction dir = LEFT;
- do
- {
- 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);
- }
-
- if (!gh_symbol_p (index_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;
- }
- }
- }
- }
- while (flip (&dir) != LEFT);
-
- check_slope (me);
+ // FIXME uncached
+ Stencil *m = me->get_stencil ();
+ return m ? ly_interval2scm (m->extent (Y_AXIS))
+ : ly_interval2scm (Interval ());
}
-
-Real
-Slur::get_first_notecolumn_y (Grob *me, Direction dir)
+MAKE_SCHEME_CALLBACK (Slur, print, 1);
+SCM
+Slur::print (SCM smob)
{
- Grob *col = dir == LEFT
- ? unsmob_grob (ly_car (scm_reverse (me->get_grob_property
- ("note-columns"))))
- : unsmob_grob
- (ly_car (me->get_grob_property ("note-columns")));
-
- Grob *common[] =
- {
- 0,
- me->common_refpoint (col, Y_AXIS)
- };
- Real y;
- if (col == ((Spanner*)me)->get_bound (dir))
+ Grob *me = Grob::unsmob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+ if (encompasses.empty ())
{
- 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);
+ me->suicide ();
+ return SCM_EOL;
}
- return y;
-}
-Offset
-Slur::broken_trend_offset (Grob *me, Direction dir)
-{
- /*
- A broken slur should maintain the same vertical trend
- the unbroken slur would have had.
- */
- Offset o;
- if (Spanner *mother = dynamic_cast<Spanner*> (me->original_l_))
+ 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);
+
+ Bezier one = get_curve (me);
+ Stencil a;
+
+ SCM dash_definition = me->get_property ("dash-definition");
+ a = Lookup::slur (one,
+ get_grob_direction (me) * base_thick,
+ line_thick,
+ dash_definition);
+
+#if DEBUG_SLUR_SCORING
+ SCM annotation = me->get_property ("annotation");
+ if (scm_is_string (annotation))
{
- for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
- dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
- dir == LEFT ? i++ : i--)
- {
- if (mother->broken_into_l_arr_[i - dir] == me)
- {
- Grob *neighbour = mother->broken_into_l_arr_[i];
- if (dir == RIGHT)
- neighbour->set_grob_property ("direction",
- me->get_grob_property ("direction"));
- Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
- Real y = get_first_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));
- break;
- }
- }
+ 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);
}
- return o;
+#endif
+
+ return a.smobbed_copy ();
}
-Offset
-Slur::get_attachment (Grob *me, Direction dir,
- Grob **common)
+/*
+ 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)
{
- SCM s = me->get_grob_property ("attachment");
- if (!gh_symbol_p (index_cell (s, dir)))
- {
- set_extremities (me);
- s = me->get_grob_property ("attachment");
- }
- SCM a = dir == LEFT ? ly_car (s) : ly_cdr (s);
- Spanner*sp = dynamic_cast<Spanner*> (me);
- String str = ly_symbol2string (a);
- Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
- Real hs = staff_space / 2.0;
- Offset o;
-
- int slurdir = gh_scm2int (me->get_grob_property ("direction"));
-
- Grob *stem = 0;
- if (Note_column::has_interface (sp->get_bound (dir)))
- {
- Grob * n =sp->get_bound (dir);
- if ((stem = Note_column::stem_l (n)))
- {
- Real x_extent;
- if (Grob *head = Note_column::first_head (n))
- x_extent = head->extent (head, X_AXIS).length ();
- else
- x_extent = n->extent (n, X_AXIS).length ();
-
- if (str == "head")
- {
- o = Offset (0, Stem::head_positions (stem)
- [Directional_element_interface::get (me)] * hs);
- /*
- Default position is centered in X, on outer side of head Y
- */
- o += Offset (0.5 * x_extent,
- 0.5 * staff_space
- * Directional_element_interface::get (me));
- }
- 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 (x_extent * (1 + Stem::get_direction (stem)),
- 0.5 * staff_space
- * Directional_element_interface::get (me));
- }
- 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 =
- gh_scm2double (stem->get_grob_property ("thickness"))
- * stem->paper_l ()->get_var ("stafflinethickness");
- 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.
+ extract_grob_set (me, "encompass-objects", extra_objects);
+ vector<Grob *> new_encompasses;
- Hmm, maybe after-line-breaking should set this to loose-end? */
- else // if (str == "loose-end")
+ for (vsize i = 0; i < extra_objects.size (); i++)
{
- SCM other_a = dir == LEFT ? ly_cdr (s) : ly_car (s);
- if (ly_symbol2string (other_a) != "loose-end")
- o = broken_trend_offset (me, dir);
+ 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);
}
- 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);
-
- if (l != SCM_BOOL_F)
+ SCM encompass_scm = me->get_object ("encompass-objects");
+ if (Grob_array::is_smob (encompass_scm))
{
- Offset off = ly_scm2offset (ly_cdr (l)) * staff_space;
- off[X_AXIS] *= dir;
- off[Y_AXIS] *= Directional_element_interface::get (me);
- o += off;
- }
-
- /*
- 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);
+ vector<Grob *> &arr
+ = Grob_array::unsmob (encompass_scm)->array_reference ();
+ arr = new_encompasses;
}
+}
- Offset off = ly_scm2offset (index_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] *= Directional_element_interface::get (me);
- 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_l = unsmob_grob (col->get_grob_property ("stem"));
-
- Direction dir = Directional_element_interface::get (me);
-
- if (!stem_l)
- {
- me->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::get (stem_l);
- o[X_AXIS] = stem_l->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<Spanner *> (me), n);
+}
- if ((stem_dir == dir)
- && !stem_l->extent (stem_l, Y_AXIS).empty_b ())
- {
- o[Y_AXIS] = stem_l->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 * gh_scm2double (me->get_grob_property ("y-free")) *
- 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<Offset>
-Slur::get_encompass_offset_arr (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<Spanner*> (me);
- SCM eltlist = me->get_grob_property ("note-columns");
- Grob *common[] = {me->common_refpoint (eltlist, X_AXIS),
- me->common_refpoint (eltlist, 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<Grob> encompass_arr;
- while (gh_pair_p (eltlist))
- {
- encompass_arr.push (unsmob_grob (ly_car (eltlist)));
- eltlist =ly_cdr (eltlist);
- }
- encompass_arr.reverse ();
+ SCM avoid = script->get_property ("avoid-slur");
+ if (avoid != ly_symbol2scm ("outside")
+ && avoid != ly_symbol2scm ("around"))
+ return offset_scm;
-
- Array<Offset> offset_arr;
+ Direction dir = get_grob_direction (script);
+ if (dir == CENTER)
+ return offset_scm;
- Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
- me->relative_coordinate (common[Y_AXIS], Y_AXIS));
+ Grob *cx = script->common_refpoint (slur, X_AXIS);
+ Grob *cy = script->common_refpoint (slur, Y_AXIS);
- int first = 1;
- int last = encompass_arr.size () - 2;
+ Bezier curve = Slur::get_curve (slur);
- offset_arr.push (get_attachment (me, LEFT, common));
+ curve.translate (Offset (slur->relative_coordinate (cx, X_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]);
/*
- left is broken edge
+ cannot use is_empty because some 0-extent scripts
+ come up with TabStaffs.
*/
+ if (xext.length () <= 0 || yext.length () <= 0)
+ return offset_scm;
- if (encompass_arr[0] != sp->get_bound (LEFT))
- {
- first--;
+ bool contains = false;
+ for (LEFT_and_RIGHT (d))
+ contains |= slur_wid.contains (xext[d]);
- // ?
- offset_arr[0][Y_AXIS] -=
- encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
- - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
- }
+ if (!contains)
+ return offset_scm;
- /*
- right is broken edge
- */
- if (encompass_arr.top () != sp->get_bound (RIGHT))
- {
- last++;
- }
+ Real offset = robust_scm2double (offset_scm, 0);
+ yext.translate (offset);
- for (int i = first; i <= last; i++)
+ /* 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"))
{
- Offset o (encompass_offset (me, encompass_arr[i], common));
- offset_arr.push (o - origin);
+ 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;
+ }
}
-
- offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
-
- if (encompass_arr[0] != sp->get_bound (LEFT))
+ else
{
- offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
- - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
+ for (int a = X_AXIS; a < NO_AXES; a++)
+ {
+ for (LEFT_and_RIGHT (d))
+ {
+ vector<Real> 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 offset_arr;
-}
-
-
+ 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);
+}
-/*
- ugh ?
- */
-MAKE_SCHEME_CALLBACK (Slur, height, 2);
+MAKE_SCHEME_CALLBACK (Slur, vertical_skylines, 1);
SCM
-Slur::height (SCM smob, SCM ax)
+Slur::vertical_skylines (SCM smob)
{
- Axis a = (Axis)gh_scm2int (ax);
- Grob * me = unsmob_grob (smob);
- assert (a == Y_AXIS);
+ Grob *me = Grob::unsmob (smob);
+ vector<Box> boxes;
- SCM mol = me->get_uncached_molecule ();
- return ly_interval2scm (unsmob_molecule (mol)->extent (a));
-}
+ if (!me)
+ return Skyline_pair (boxes, X_AXIS).smobbed_copy ();
-/*
- Ugh should have dash-length + dash-period
- */
-MAKE_SCHEME_CALLBACK (Slur, brew_molecule,1);
-SCM
-Slur::brew_molecule (SCM smob)
-{
- Grob * me = unsmob_grob (smob);
- if (!scm_ilength (me->get_grob_property ("note-columns")))
+ 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++)
{
- me->suicide ();
- return SCM_EOL;
+ 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);
}
- Real thick = me->paper_l ()->get_var ("stafflinethickness") *
- gh_scm2double (me->get_grob_property ("thickness"));
- Bezier one = get_curve (me);
-
- // get_curve may suicide
- if (!scm_ilength (me->get_grob_property ("note-columns")))
- return SCM_EOL;
-
- Molecule a;
- SCM d = me->get_grob_property ("dashed");
- if (gh_number_p (d))
- a = Lookup::dashed_slur (one, thick, thick * gh_scm2double (d));
- else
- a = Lookup::slur (one, Directional_element_interface::get (me) * thick, thick);
-
- 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<Grob *> &slurs,
+ vector<Grob *> &end_slurs)
{
- Real staff_space = Staff_symbol_referencer::staff_space ((Grob*)me);
-
- SCM details = me->get_grob_property ("details");
- SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
- SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
-
- Real r_0 = gh_scm2double (ly_cdr (r_0_scm));
- Real h_inf = staff_space * gh_scm2double (ly_cdr (h_inf_scm));
-
- Slur_bezier_bow bb (get_encompass_offset_arr (me),
- Directional_element_interface::get (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.enclosed_area_f ();
-
- /*
- 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)
+
+/*
+ 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)
{
- Bezier b;
- int i = 0;
+ if (previous == SCM_BOOL_T)
+ return previous;
- if (!Directional_element_interface::get (me)
- || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), LEFT))
- || ! gh_symbol_p (index_cell (me->get_grob_property ("attachment"), 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<Offset> enc (get_encompass_offset_arr (me));
- Direction dir = Directional_element_interface::get (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 <x2)
- {
- Real y = b.get_other_coordinate (X_AXIS, x);
- off = off >? 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<Grob *> 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]);
-bool
-Slur::has_interface (Grob*me)
-{
- return me->has_interface (ly_symbol2scm ("slur-interface"));
+ 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,
+ "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 "
+ );
projects / lilypond.git / blobdiff