/*
- slur.cc -- implement Slur
+ slur.cc -- implement external interface for Slur
source file of the GNU LilyPond music typesetter
- (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
- Jan Nieuwenhuizen <janneke@gnu.org>
+ (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
*/
-/*
- [TODO]
- * begin and end should be treated as a/acknowledge Scripts.
- * broken slur should have uniform trend
- */
-
-#include "group-interface.hh"
#include "slur.hh"
+
+
+#include "beam.hh"
+#include "bezier.hh"
+#include "directional-element-interface.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 "output-def.hh"
+#include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "staff-symbol.hh"
#include "stem.hh"
-#include "paper-column.hh"
-#include "molecule.hh"
-#include "debug.hh"
-#include "box.hh"
-#include "bezier.hh"
-#include "main.hh"
-#include "cross-staff.hh"
-#include "group-interface.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+#include "slur-scoring.hh"
-Slur::Slur ()
-{
- set_elt_property ("note-columns", SCM_EOL);
-}
+#include "script-interface.hh"
-void
-Slur::add_column (Note_column*n)
+
+
+MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
+SCM
+Slur::calc_direction (SCM smob)
{
- if (!gh_pair_p (n->get_elt_property ("note-heads")))
- warning (_ ("Putting slur over rest. Ignoring."));
- else
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+
+ if (encompasses.empty ())
{
- Group_interface gi (this, "note-columns");
- gi.add_element (n);
- add_dependency (n);
+ me->suicide ();
+ return SCM_BOOL_F;
}
-}
-Direction
-Slur::get_default_dir () const
-{
- Link_array<Note_column> encompass_arr =
- Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
-
Direction d = DOWN;
- for (int i=0; i < encompass_arr.size (); i ++)
+ for (vsize i = 0; i < encompasses.size (); i++)
{
- if (encompass_arr[i]->dir () < 0)
+ if (Note_column::dir (encompasses[i]) < 0)
{
d = UP;
break;
}
}
- return d;
-}
-
-void
-Slur::do_add_processing ()
-{
- Link_array<Note_column> encompass_arr =
- Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
- set_bounds (LEFT, encompass_arr[0]);
- if (encompass_arr.size () > 1)
- set_bounds (RIGHT, encompass_arr.top ());
-}
-
-void
-Slur::do_pre_processing ()
-{
- // don't set directions
+ return scm_from_int (d);
}
-
-Offset
-Slur::encompass_offset (Note_column const* col) const
+MAKE_SCHEME_CALLBACK (Slur, height, 1);
+SCM
+Slur::height (SCM smob)
{
- Offset o;
- Stem* stem_l = col->stem_l ();
- if (!stem_l)
- {
- warning (_ ("Slur over rest?"));
- o[X_AXIS] = col->hpos_f ();
- o[Y_AXIS] = col->extent (Y_AXIS)[get_direction ()];
- return o;
- }
-
- o[X_AXIS] = stem_l->hpos_f ();
-
- /*
- Simply set x to middle of notehead
- */
-
- o[X_AXIS] -= 0.5 * stem_l->get_direction () * col->extent (X_AXIS).length ();
-
- if ((stem_l->get_direction () == get_direction ())
- && !stem_l->extent (Y_AXIS).empty_b ())
- {
- o[Y_AXIS] = stem_l->extent (Y_AXIS)[get_direction ()];
- }
- else
- {
- o[Y_AXIS] = col->extent (Y_AXIS)[get_direction ()];
- }
+ Grob *me = unsmob_grob (smob);
- /*
- leave a gap: slur mustn't touch head/stem
- */
- o[Y_AXIS] += get_direction () * paper_l ()->get_var ("slur_y_free");
- o[Y_AXIS] += calc_interstaff_dist (stem_l, this);
- return o;
+ // FIXME uncached
+ Stencil *m = me->get_stencil ();
+ return m ? ly_interval2scm (m->extent (Y_AXIS))
+ : ly_interval2scm (Interval ());
}
/*
- ARGRARGRARGRARGAR!
-
- Fixme
- */
-void
-Slur::do_post_processing ()
+ Ugh should have dash-length + dash-period
+*/
+MAKE_SCHEME_CALLBACK (Slur, print, 1);
+SCM
+Slur::print (SCM smob)
{
- Link_array<Note_column> encompass_arr =
- Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
-
-
- if (!get_direction ())
- set_direction (get_default_dir ());
-
- /*
- Slur and tie placement [OSU]
-
- Slurs:
- * x = centre of head - d * x_gap_f
-
- TODO:
- * y = length < 5ss : horizontal tangent + d * 0.25 ss
- y = length >= 5ss : y next interline - d * 0.25 ss
- */
-
- Real interline_f = paper_l ()->get_var ("interline");
- Real internote_f = interline_f / 2;
-
- Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
- Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
-
- Drul_array<Note_column*> note_column_drul;
- note_column_drul[LEFT] = encompass_arr[0];
- note_column_drul[RIGHT] = encompass_arr.top ();
-
- bool fix_broken_b = false;
- Direction d = LEFT;
- do
- {
- dx_f_drul_[d] = 0;
- dy_f_drul_[d] = 0;
-
- if ((note_column_drul[d] == spanned_drul_[d])
- && note_column_drul[d]->first_head ()
- && (note_column_drul[d]->stem_l ()))
- {
- Stem* stem_l = note_column_drul[d]->stem_l ();
- /*
- side directly attached to note head;
- no beam getting in the way
- */
- if ((stem_l->extent (Y_AXIS).empty_b ()
- || !((stem_l->get_direction () == get_direction ()) && (get_direction () != d)))
- && !((get_direction () == stem_l->get_direction ())
- && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
- {
- dx_f_drul_[d] = spanned_drul_[d]->extent (X_AXIS).length () / 2;
- dx_f_drul_[d] -= d * x_gap_f;
-
- if (stem_l->get_direction () != get_direction ())
- {
- dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[get_direction ()];
- }
- else
- {
- dy_f_drul_[d] = stem_l->chord_start_f ()
- + get_direction () * internote_f;
- }
- dy_f_drul_[d] += get_direction () * y_gap_f;
- }
- /*
- side attached to (visible) stem
- */
- else
- {
- dx_f_drul_[d] = stem_l->hpos_f ()
- - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
- /*
- side attached to beamed stem
- */
- if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
- {
- dy_f_drul_[d] = stem_l->extent (Y_AXIS)[get_direction ()];
- dy_f_drul_[d] += get_direction () * 2 * y_gap_f;
- }
- /*
- side attached to notehead, with stem getting in the way
- */
- else
- {
- dx_f_drul_[d] -= d * x_gap_f;
-
- dy_f_drul_[d] = stem_l->chord_start_f ()
- + get_direction () * internote_f;
- dy_f_drul_[d] += get_direction () * y_gap_f;
- }
- }
- }
- /*
- loose end
- */
- else
- {
- dx_f_drul_[d] = get_broken_left_end_align ();
-
- /*
- broken: should get y from other piece, so that slur
- continues up/down trend
-
- for now: be horizontal..
- */
- fix_broken_b = true;
- }
- }
- while (flip (&d) != LEFT);
-
- int cross_count = cross_staff_count ();
- bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
-
- Drul_array<Offset> info_drul;
- Drul_array<Real> interstaff_interval;
-
- do
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+ if (encompasses.empty ())
{
- info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
- interstaff_interval[d] = calc_interstaff_dist (encompass_arr.boundary (d,0),
- this);
+ me->suicide ();
+ return SCM_EOL;
}
- while (flip (&d) != LEFT);
-
- Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
- if (fix_broken_b)
- {
- Direction d = (encompass_arr.top () != spanned_drul_[RIGHT]) ?
- RIGHT : LEFT;
- dy_f_drul_[d] = info_drul[d][Y_AXIS];
- if (!interstaff_b)
- {
- dy_f_drul_[d] -= interstaff_interval[d];
- if (cross_count) // interstaff_i ?
- {
- dy_f_drul_[LEFT] += interstaff_interval[d];
- dy_f_drul_[RIGHT] += interstaff_interval[d];
- }
- }
- }
-
+ 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);
- /*
- Now we've got a fine slur
- Catch and correct some ugly cases
- */
- String infix = interstaff_b ? "interstaff_" : "";
- Real height_damp_f = paper_l ()->get_var ("slur_"+infix +"height_damping");
- Real slope_damp_f = paper_l ()->get_var ("slur_"+infix +"slope_damping");
- Real snap_f = paper_l ()->get_var ("slur_"+infix +"snap_to_stem");
- Real snap_max_dy_f = paper_l ()->get_var ("slur_"+infix +"snap_max_slope_change");
-
- if (!fix_broken_b)
- dy_f_drul_[RIGHT] += interstaff_f;
-
- Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
- if (!fix_broken_b)
- dy_f -= interstaff_f;
- Real dx_f = spanner_length ()+ dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
+ Bezier one = get_curve (me);
+ Stencil a;
/*
- Avoid too steep slurs.
- */
- Real slope_ratio_f = abs (dy_f / dx_f);
- if (slope_ratio_f > slope_damp_f)
- {
- Direction d = (Direction)(- get_direction () * (sign (dy_f)));
- if (!d)
- d = LEFT;
- Real damp_f = (slope_ratio_f - slope_damp_f) * dx_f;
- /*
- must never change sign of dy
- */
- damp_f = damp_f <? abs (dy_f);
- dy_f_drul_[d] += get_direction () * damp_f;
- }
+ 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);
- /*
- Avoid too high slurs
+#if DEBUG_SLUR_SCORING
+ SCM quant_score = me->get_property ("quant-score");
- Wierd slurs may look a lot better after they have been
- adjusted a bit.
- So, we'll do this in 3 steps
- */
- for (int i = 0; i < 3; i++)
+ if (to_boolean (me->layout ()
+ ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
+ && scm_is_string (quant_score))
{
- Real height_f = curve_extent (Y_AXIS).length ();
- Real width_f = curve_extent (X_AXIS).length ();
-
- dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
- if (!fix_broken_b)
- dy_f -= interstaff_f;
-
- Real height_ratio_f = abs (height_f / width_f);
- if (height_ratio_f > height_damp_f)
- {
- Direction d = (Direction)(- get_direction () * (sign (dy_f)));
- if (!d)
- d = LEFT;
- /* take third step */
- Real damp_f = (height_ratio_f - height_damp_f) * width_f / 3;
- /*
- if y positions at about the same height, correct both ends
- */
- if (abs (dy_f / dx_f ) < slope_damp_f)
- {
- dy_f_drul_[-d] += get_direction () * damp_f;
- dy_f_drul_[d] += get_direction () * damp_f;
- }
- /*
- don't change slope too much, would have been catched by slope damping
- */
- else
- {
- damp_f = damp_f <? abs (dy_f/2);
- dy_f_drul_[d] += get_direction () * damp_f;
- }
- }
- }
+ string str;
+ SCM properties = Font_interface::text_font_alist_chain (me);
- /*
- If, after correcting, we're close to stem-end...
- */
- Drul_array<Real> snapy_f_drul;
- snapy_f_drul[LEFT] = snapy_f_drul[RIGHT] = 0;
- Drul_array<Real> snapx_f_drul;
- snapx_f_drul[LEFT] = snapx_f_drul[RIGHT] = 0;
- Drul_array<bool> snapped_b_drul;
- snapped_b_drul[LEFT] = snapped_b_drul[RIGHT] = false;
- do
- {
- Note_column * nc = note_column_drul[d];
- if (nc == spanned_drul_[d]
- && nc->stem_l ()
- && nc->stem_l ()->get_direction () == get_direction ()
- && abs (nc->stem_l ()->extent (Y_AXIS)[get_direction ()]
- - dy_f_drul_[d] + (d == LEFT ? 0 : interstaff_f))
- <= snap_f)
- {
- /*
- prepare to attach to stem-end
- */
- snapx_f_drul[d] = nc->stem_l ()->hpos_f ()
- - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
-
- snapy_f_drul[d] = nc->stem_l ()->extent (Y_AXIS)[get_direction ()]
- + interstaff_interval[d]
- + get_direction () * 2 * y_gap_f;
-
- snapped_b_drul[d] = true;
- }
+ 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);
}
- while (flip (&d) != LEFT);
+#endif
- /*
- only use snapped positions if sign (dy) will not change
- and dy doesn't change too much
- */
- if (!fix_broken_b)
- dy_f += interstaff_f;
+ return a.smobbed_copy ();
+}
+Bezier
+Slur::get_curve (Grob *me)
+{
+ Bezier b;
+ int i = 0;
+ for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
+ s = scm_cdr (s))
+ b.control_[i++] = ly_scm2offset (scm_car (s));
- /*
- (sigh)
-
- More refactoring could be done.
- */
- Real maxsnap = abs (dy_f * snap_max_dy_f);
- if (snapped_b_drul[LEFT] && snapped_b_drul[RIGHT]
- && ((sign (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT]) == sign (dy_f)))
- && (!dy_f || (abs (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT] - dy_f)
- < maxsnap)))
- {
- dy_f_drul_ = snapy_f_drul;
- dx_f_drul_ = snapx_f_drul;
- }
- else
- do
- {
- Direction od = (Direction)-d;
- if (snapped_b_drul[d]
- && d * sign (snapy_f_drul[d] - dy_f_drul_[od]) == sign (dy_f)
- && (!dy_f || (abs (snapy_f_drul[d] - dy_f_drul_[od] - d * dy_f)
- < maxsnap)))
- {
- dy_f_drul_[d] = snapy_f_drul[d];
- dx_f_drul_[d] = snapx_f_drul[d];
- }
- }
- while (flip (&d) != LEFT);
+ return b;
}
-
-int
-Slur::cross_staff_count ()const
+void
+Slur::add_column (Grob *me, Grob *n)
{
- Link_array<Note_column> encompass_arr =
- Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
-
- int k=0;
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
+ add_bound_item (dynamic_cast<Spanner *> (me), dynamic_cast<Item *> (n));
+}
- for (int i = 0; i < encompass_arr.size (); i++)
- {
- if (calc_interstaff_dist (encompass_arr[i], this))
- k++;
- }
- return k;
+void
+Slur::add_extra_encompass (Grob *me, Grob *n)
+{
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
}
-Array<Offset>
-Slur::get_encompass_offset_arr () const
+MAKE_SCHEME_CALLBACK (Slur, outside_slur_callback, 2);
+SCM
+Slur::outside_slur_callback (SCM grob, SCM offset_scm)
{
- Link_array<Note_column> encompass_arr =
- Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
-
- Array<Offset> offset_arr;
-#if 0
- /*
- check non-disturbed slur
- FIXME: x of ends off by a tiny bit!!
- */
- offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
- offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
- return offset_arr;
-#endif
+ Grob *script = unsmob_grob (grob);
+ Grob *slur = unsmob_grob (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;
- Offset origin (relative_coordinate (0, X_AXIS), 0);
+ Direction dir = get_grob_direction (script);
+ if (dir == CENTER)
+ return offset_scm;
- int first = 1;
- int last = encompass_arr.size () - 2;
+ Grob *cx = script->common_refpoint (slur, X_AXIS);
+ Grob *cy = script->common_refpoint (slur, Y_AXIS);
- offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
+ Bezier curve = Slur::get_curve (slur);
- /*
- left is broken edge
- */
+ curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
+ slur->relative_coordinate (cy, Y_AXIS)));
- int cross_count = cross_staff_count ();
- bool cross_b = cross_count && cross_count < encompass_arr.size ();
- if (encompass_arr[0] != spanned_drul_[LEFT])
- {
- first--;
- Real is = calc_interstaff_dist (encompass_arr[0], this);
- if (cross_b)
- offset_arr[0][Y_AXIS] += is;
- }
+ Interval yext = robust_relative_extent (script, cy, Y_AXIS);
+ Interval xext = robust_relative_extent (script, cx, X_AXIS);
- /*
- right is broken edge
- */
- if (encompass_arr.top () != spanned_drul_[RIGHT])
+ yext.translate (robust_scm2double (offset_scm, 0));
+
+
+ /* 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;
+
+ for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
{
- last++;
+ 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));
+ consider[k] = true;
+
+ /* 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;
+ }
}
- for (int i = first; i <= last; i++)
+ Real avoidance_offset = 0.0;
+ if (do_shift)
{
- Offset o (encompass_offset (encompass_arr[i]));
- offset_arr.push (o - origin);
+ for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
+ avoidance_offset = dir * (max (dir * avoidance_offset,
+ dir * (ys[k] - yext[-dir] + dir * slur_padding)));
}
- offset_arr.push (Offset (spanner_length ()+ dx_f_drul_[RIGHT],
- dy_f_drul_[RIGHT]));
-
- return offset_arr;
+ return scm_from_double (scm_to_double (offset_scm) + avoidance_offset);
}
-Array<Rod>
-Slur::get_rods () const
-{
- Array<Rod> a;
- Rod r;
- r.item_l_drul_ = spanned_drul_;
- r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
-
- a.push (r);
- return a;
-}
+ADD_INTERFACE (Slur, "slur-interface",
+
+ "A slur",
+
+ /* properties */
+ "control-points "
+ "dash-fraction "
+ "dash-period "
+ "details "
+ "direction "
+ "eccentricity "
+ "encompass-objects "
+ "height-limit "
+ "line-thickness "
+ "note-columns "
+ "positions "
+ "quant-score "
+ "ratio "
+ "thickness "
+
+ );