/*
- slur.cc -- implement Slur
+ slur.cc -- implement external interface for Slur
source file of the GNU LilyPond music typesetter
- (c) 1996, 1997--1999, 1998 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]
- * URG: share code with tie
- * begin and end should be treated as a Script.
- * damping
- * slur from notehead to stemend: c''()b''
- */
-
#include "slur.hh"
-#include "scalar.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 "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 "p-col.hh"
-#include "molecule.hh"
-#include "debug.hh"
-#include "box.hh"
-#include "bezier.hh"
-#include "encompass-info.hh"
-#include "main.hh"
+#include "text-interface.hh"
+#include "tie.hh"
+#include "warn.hh"
+#include "slur-scoring.hh"
+#include "separation-item.hh"
+#include "script-interface.hh"
-Slur::Slur ()
-{
-}
-void
-Slur::add_column (Note_column*n)
+MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
+SCM
+Slur::calc_direction (SCM smob)
{
- if (!n->head_l_arr_.size ())
- warning (_ ("Putting slur over rest."));
- encompass_arr_.push (n);
- n->stem_l_->slur_l_ = this;
- add_dependency (n);
-}
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
-void
-Slur::set_default_dir ()
-{
- dir_ = DOWN;
- for (int i=0; i < encompass_arr_.size (); i ++)
+ if (encompasses.empty ())
{
- if (encompass_arr_[i]->dir_ < 0)
+ me->suicide ();
+ return SCM_BOOL_F;
+ }
+
+ Direction d = DOWN;
+ for (vsize i = 0; i < encompasses.size (); i++)
+ {
+ if (Note_column::dir (encompasses[i]) < 0)
{
- dir_ = UP;
+ d = UP;
break;
}
}
+ return scm_from_int (d);
}
-void
-Slur::do_add_processing ()
+MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
+SCM
+Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
{
- set_bounds (LEFT, encompass_arr_[0]);
- if (encompass_arr_.size () > 1)
- set_bounds (RIGHT, encompass_arr_.top ());
-}
+ Grob *me = unsmob_grob (smob);
+ int start = scm_to_int (start_scm);
+ int end = scm_to_int (end_scm);
+ Real height = robust_scm2double (me->get_property ("height-limit"), 2.0);
-void
-Slur::do_pre_processing ()
-{
- // don't set directions
-}
+ extract_grob_set (me, "note-columns", encompasses);
+ Interval ret;
-void
-Slur::do_substitute_dependency (Score_element*o, Score_element*n)
-{
- int i;
- while ((i = encompass_arr_.find_i (dynamic_cast<Note_column *> (o))) >=0)
+ Grob *parent = me->get_parent (Y_AXIS);
+ if (common_refpoint_of_array (encompasses, me, Y_AXIS) != parent)
+ /* this could happen if, for example, we are a cross-staff slur.
+ in this case, we want to be ignored */
+ return ly_interval2scm (Interval ());
+
+ for (vsize i = 0; i < encompasses.size (); i++)
{
- if (n)
- encompass_arr_[i] = dynamic_cast<Note_column *> (n);
- else
- encompass_arr_.del (i);
+ Interval d = encompasses[i]->pure_height (parent, start, end);
+ if (!d.is_empty ())
+ ret.unite (d);
}
+
+ ret.widen (height * 0.5);
+ return ly_interval2scm (ret);
}
-static int
-Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
+MAKE_SCHEME_CALLBACK (Slur, height, 1);
+SCM
+Slur::height (SCM smob)
{
- return Item::left_right_compare (n1, n2);
+ Grob *me = unsmob_grob (smob);
+
+ // FIXME uncached
+ Stencil *m = me->get_stencil ();
+ return m ? ly_interval2scm (m->extent (Y_AXIS))
+ : ly_interval2scm (Interval ());
}
-void
-Slur::do_post_processing ()
+/*
+ Ugh should have dash-length + dash-period
+*/
+MAKE_SCHEME_CALLBACK (Slur, print, 1);
+SCM
+Slur::print (SCM smob)
{
- encompass_arr_.sort (Note_column_compare);
- if (!dir_)
- set_default_dir ();
-
- Real interline_f = paper ()->interline_f ();
- Real internote_f = interline_f / 2;
- // URG
- Real notewidth_f = paper ()->note_width () * 0.8;
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+ if (encompasses.empty ())
+ {
+ me->suicide ();
+ return SCM_EOL;
+ }
- /*
- [OSU]: slur and tie placement
+ 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);
- slurs:
- * x = centre of head (upside-down: inner raakpunt stem) - d * gap
+ Bezier one = get_curve (me);
+ Stencil a;
- * y = length < 5ss : horizontal raakpunt + d * 0.25 ss
- y = length >= 5ss : y next interline - d * 0.25 ss
- --> height <= 5 length ?? we use <= 3 length, now...
- */
-
- Real gap_f = paper ()->get_var ("slur_x_gap");
-
- Drul_array<Note_column*> extrema;
- extrema[LEFT] = encompass_arr_[0];
- extrema[RIGHT] = encompass_arr_.top ();
-
- Direction d=LEFT;
-
-#define BROKEN_SLUR_b(dir) \
- (extrema[dir] != spanned_drul_[d])
-#define NORMAL_SLUR_b(dir) \
- (extrema[dir]->stem_l_ \
- && !extrema[dir]->stem_l_->transparent_b_ \
- && extrema[dir]->head_l_arr_.size ())
-
- do
- {
- if (BROKEN_SLUR_b (d))
- {
- // ugh -- check if needed
- dx_f_drul_[d] = -d
- *(spanned_drul_[d]->extent (X_AXIS).length () - 0.5 * notewidth_f);
-
- // prebreak
- if (d == RIGHT)
- {
- dx_f_drul_[LEFT] = spanned_drul_[LEFT]->extent (X_AXIS).length ();
-
- // urg -- check if needed
- if (encompass_arr_.size () > 1)
- dx_f_drul_[RIGHT] += notewidth_f;
- }
- }
- /*
- normal slur
- */
- else if (NORMAL_SLUR_b (d))
- {
- Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
- dy_f_drul_[d] = (int)rint (extrema[d]->stem_l_-> extent (Y_AXIS)[dir_]);
- dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
- if (dir_ == extrema[d]->stem_l_->dir_)
- {
- if (dir_ == d)
- dx_f_drul_[d] += 0.5 * (dir_ * d) * d * notewidth_f;
- else
- dx_f_drul_[d] += 0.25 * (dir_ * d) * d * notewidth_f;
- }
- }
- else
- {
- Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
- dy_f_drul_[d] = (int)rint (extrema[d]->head_positions_interval ()
- [dir_]) * internote_f;
- dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
- }
- dy_f_drul_[d] += dir_ * interline_f;
- if (extrema[d]->stem_l_ && (dir_ == extrema[d]->stem_l_->dir_))
- dy_f_drul_[d] -= dir_ * internote_f;
- }
- while (flip(&d) != LEFT);
-
- // now that both are set, do dependent
- do
+ /*
+ TODO: replace dashed with generic property.
+ */
+ SCM p = me->get_property ("dash-period");
+ SCM f = me->get_property ("dash-fraction");
+ if (scm_is_number (p) && scm_is_number (f))
+ a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
+ robust_scm2double (f, 0));
+ else
+ a = Lookup::slur (one,
+ get_grob_direction (me) * base_thick,
+ line_thick);
+
+#if DEBUG_SLUR_SCORING
+ SCM quant_score = me->get_property ("quant-score");
+
+ if (to_boolean (me->layout ()
+ ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
+ && scm_is_string (quant_score))
{
- if (BROKEN_SLUR_b (d))
- {
- Direction u = d;
- flip(&u);
+ 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 = *unsmob_stencil (Text_interface::interpret_markup
+ (me->layout ()->self_scm (), properties,
+ quant_score));
+ a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0, 0);
+ }
+#endif
- // postbreak
- if (d == LEFT)
- dy_f_drul_[u] += dir_ * internote_f;
+ return a.smobbed_copy ();
+}
- dy_f_drul_[d] = dy_f_drul_[u];
- }
- }
- while (flip(&d) != LEFT);
- /*
- Slur should follow line of music
- */
- if (!BROKEN_SLUR_b (LEFT) && !BROKEN_SLUR_b (RIGHT)
- && NORMAL_SLUR_b (LEFT) && NORMAL_SLUR_b (RIGHT)
- && (extrema[LEFT]->stem_l_ != extrema[RIGHT]->stem_l_))
+/*
+ it would be better to do this at engraver level, but that is
+ fragile, as the breakabl 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<Grob *> new_encompasses;
+
+ for (vsize i = 0; i < extra_objects.size (); i++)
{
- Real note_dy = extrema[RIGHT]->stem_l_->head_positions ()[dir_]
- - extrema[LEFT]->stem_l_->head_positions ()[dir_];
- Real dy = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
- /*
- Should we always follow note-heads, (like a tie)?
- For now, only if the note_dy != slur_dy, we'll do
- slur_dy := note_dy * factor.
- */
- if (sign (dy) != sign (note_dy))
+ Grob *g = extra_objects[i];
+
+ if (Separation_item::has_interface (g))
{
- Real damp_f = paper ()->get_var ("slur_slope_follow_music_factor");
- Real realdy = note_dy * damp_f;
- Direction adjust_dir = (Direction)(- dir_ * sign (realdy));
- if (!adjust_dir)
- adjust_dir = -dir_;
- /*
- adjust only if no beam gets in the way
- */
- if (!extrema[adjust_dir]->stem_l_->beam_l_
- || (adjust_dir == extrema[adjust_dir]->stem_l_->dir_)
- || (extrema[adjust_dir]->stem_l_->beams_i_drul_[-adjust_dir] < 1))
- {
- dy_f_drul_[adjust_dir] = dy_f_drul_[-adjust_dir]
- + 2 * adjust_dir * realdy;
- Real dx = notewidth_f / 2;
- if (adjust_dir != extrema[adjust_dir]->stem_l_->dir_)
- dx /= 2;
- dx_f_drul_[adjust_dir] -= adjust_dir * dx;
- }
+ extract_grob_set (g, "elements", breakables);
+ for (vsize j = 0; j < breakables.size (); j++)
+ if (breakables[j]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
+ new_encompasses.push_back (breakables[j]);
}
+ else
+ new_encompasses.push_back (g);
}
- /*
- Avoid too steep slurs.
- */
- Real damp_f = paper ()->get_var ("slur_slope_damping");
- Offset d_off = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
- dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
- d_off[X_AXIS] += extent (X_AXIS).length ();
-
- Real ratio_f = abs (d_off[Y_AXIS] / d_off[X_AXIS]);
- if (ratio_f > damp_f)
- dy_f_drul_[(Direction)(- dir_ * sign (d_off[Y_AXIS]))] +=
- dir_ * (ratio_f - damp_f) * d_off[X_AXIS];
+ SCM encompass_scm = me->get_object ("encompass-objects");
+ if (Grob_array::unsmob (encompass_scm))
+ {
+ vector<Grob *> &arr =
+ unsmob_grob_array (encompass_scm)->array_reference ();
+ arr = new_encompasses;
+ }
}
-Array<Offset>
-Slur::get_encompass_offset_arr () const
+Bezier
+Slur::get_curve (Grob *me)
{
- Real notewidth = paper ()->note_width () * 0.8;
- Real gap = paper ()->get_var ("slur_x_gap");
- Real internote = paper ()->internote_f ();
+ 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));
- Offset left = Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]);
- left[X_AXIS] += encompass_arr_[0]->stem_l_->hpos_f ();
+ return b;
+}
- /*
- <URG>
- i don't understand these two, but *must* for symmetry
- look at encompass array:
- lilypond -D input/test/slur-symmetry*.ly
- lilypond -D input/test/sleur.ly
+void
+Slur::add_column (Grob *me, Grob *n)
+{
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
+ add_bound_item (dynamic_cast<Spanner *> (me), n);
+}
- do_post_processing should have calculated these into
- dx_f_drul_[], no??
+void
+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);
+ 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;
+
+ 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);
+}
- if (dir_ != encompass_arr_[0]->stem_l_->dir_)
- left[X_AXIS] += - 0.5 * notewidth * encompass_arr_[0]->stem_l_->dir_
- + gap;
- else if (encompass_arr_[0]->stem_l_->dir_ == UP)
- left[X_AXIS] -= notewidth;
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1);
+SCM
+Slur::outside_slur_callback (SCM grob, SCM offset_scm)
+{
+ Grob *script = unsmob_grob (grob);
+ Grob *slur = unsmob_grob (script->get_object ("slur"));
- if ((dir_ == encompass_arr_[0]->stem_l_->dir_)
- && (encompass_arr_[0]->stem_l_->dir_ == DOWN))
- left[Y_AXIS] -= internote * encompass_arr_[0]->stem_l_->dir_;
- /* </URG> */
+ if (!slur)
+ return offset_scm;
- Offset d = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
- dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
- d[X_AXIS] += extent (X_AXIS).length ();
+ SCM avoid = script->get_property ("avoid-slur");
+ if (avoid != ly_symbol2scm ("outside")
+ && avoid != ly_symbol2scm ("around"))
+ return offset_scm;
+
+ Direction dir = get_grob_direction (script);
+ if (dir == CENTER)
+ return offset_scm;
- int first = 1;
- int last = encompass_arr_.size () - 1;
+ Grob *cx = script->common_refpoint (slur, X_AXIS);
+ Grob *cy = script->common_refpoint (slur, Y_AXIS);
- // prebreak
- if (encompass_arr_.top () != spanned_drul_[RIGHT])
- last++;
+ Bezier curve = Slur::get_curve (slur);
- // postbreak
- if (encompass_arr_[0] != spanned_drul_[LEFT])
- first--;
+ curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
+ slur->relative_coordinate (cy, Y_AXIS)));
- Array<Offset> notes;
- notes.push (Offset (0,0));
+ Interval yext = robust_relative_extent (script, cy, Y_AXIS);
+ Interval xext = robust_relative_extent (script, cx, X_AXIS);
- for (int i = first; i < last; i++)
- {
- Encompass_info info (encompass_arr_[i], dir_);
- notes.push (info.o_ - left);
- }
- Encompass_info info (encompass_arr_.top (), dir_);
- // [encompass_arr_.size () - 1]
+ Real offset = robust_scm2double (offset_scm, 0);
+ yext.translate (offset);
- // urg:
- Slur* urg = (Slur*)this;
- urg->interstaff_f_ = info.interstaff_f_;
+ /* 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;
- d[Y_AXIS] += interstaff_f_;
-
- // prebreak
- if (interstaff_f_ && (encompass_arr_.top () != spanned_drul_[RIGHT]))
+ for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
{
- Encompass_info info (encompass_arr_[encompass_arr_.size () - 1], dir_);
- d[Y_AXIS] -= info.o_[Y_AXIS] - interstaff_f_;
- }
+ Real x = xext.linear_combination ((Direction) d);
+ consider[k] = bezext.contains (x);
- notes.push (d);
+ if (consider[k])
+ {
+ ys[k]
+ = (fabs (bezext[LEFT] - x) < EPS)
+ ? curve.control_[0][Y_AXIS]
+ : ((fabs (bezext[RIGHT] - x) < EPS)
+ ? curve.control_[3][Y_AXIS]
+ : curve.get_other_coordinate (X_AXIS, x));
+
+ /* Request shift if slur is contained script's Y, or if
+ script is inside slur and avoid == outside. */
+ if (yext.contains (ys[k])
+ || (dir * ys[k] > dir * yext[-dir] && avoid == ly_symbol2scm ("outside")))
+ do_shift = true;
+ }
+ }
- return notes;
+ Real avoidance_offset = 0.0;
+ for (int d = LEFT, k = 0; d <= RIGHT; d++, k++)
+ if (consider[k])
+ avoidance_offset = dir * (max (dir * avoidance_offset,
+ dir * (ys[k] - yext[-dir] + dir * slur_padding)));
+
+ return scm_from_double (offset + avoidance_offset);
}
-
-Array<Rod>
-Slur::get_rods () const
+/*
+ * Used by Slur_engraver:: and Phrasing_slur_engraver::
+ */
+void
+Slur::auxiliary_acknowledge_extra_object (Grob_info const &info,
+ vector<Grob*> &slurs,
+ vector<Grob*> &end_slurs)
{
- Array<Rod> a;
- Rod r;
- r.item_l_drul_ = spanned_drul_;
- r.distance_f_ = paper ()->get_var ("slur_x_minimum");
+ if (slurs.empty () && end_slurs.empty ())
+ return;
+
+ Grob *e = info.grob ();
+ SCM avoid = e->get_property ("avoid-slur");
+ if (Tie::has_interface (e)
+ || avoid == ly_symbol2scm ("inside"))
+ {
+ for (vsize i = slurs.size (); i--;)
+ add_extra_encompass (slurs[i], e);
+ for (vsize i = end_slurs.size (); i--;)
+ add_extra_encompass (end_slurs[i], e);
+ }
+ else if (avoid == ly_symbol2scm ("outside")
+ || avoid == ly_symbol2scm ("around"))
+ {
+ Grob *slur;
+ if (end_slurs.size () && !slurs.size ())
+ slur = end_slurs[0];
+ else
+ slur = slurs[0];
- a.push (r);
- return a;
+ if (slur)
+ {
+ chain_offset_callback (e, outside_slur_callback_proc, Y_AXIS);
+ e->set_object ("slur", slur->self_scm ());
+ }
+ }
+ else
+ e->warning ("Ignoring grob for slur. avoid-slur not set?");
}
+
+ADD_INTERFACE (Slur,
+
+ "A slur",
+
+ /* properties */
+ "avoid-slur " /* UGH. */
+ "control-points "
+ "dash-fraction "
+ "dash-period "
+ "details "
+ "direction "
+ "eccentricity "
+ "encompass-objects "
+ "height-limit "
+ "inspect-quants "
+ "inspect-index "
+ "line-thickness "
+ "note-columns "
+ "positions "
+ "quant-score "
+ "ratio "
+ "thickness "
+ );
+
projects / lilypond.git / blobdiff