/*
- slur.cc -- implement Slur
+ slur.cc -- implement external interface for Slur
source file of the GNU LilyPond music typesetter
- (c) 1996, 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Jan Nieuwenhuizen <janneke@gnu.org>
*/
-/*
- TODO:
-
- think about crossing stems.
- Begin and end should be treated as a Script.
- */
#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 "boxes.hh"
-#include "bezier.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"
-IMPLEMENT_IS_TYPE_B1(Slur,Spanner);
-void
-Slur::add (Note_column*n)
-{
- encompass_arr_.push (n);
- add_dependency (n);
-}
-void
-Slur::set_default_dir ()
+MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
+SCM
+Slur::calc_direction (SCM smob)
{
- dir_ = DOWN;
- for (int i=0; i < encompass_arr_.size (); i ++)
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+
+ if (encompasses.empty ())
+ {
+ me->suicide ();
+ return SCM_BOOL_F;
+ }
+
+ Direction d = DOWN;
+ for (vsize i = 0; i < encompasses.size (); i++)
{
- if (encompass_arr_[i]->dir_ < 0)
+ 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);
+
+ extract_grob_set (me, "note-columns", encompasses);
+ Interval ret;
+
+ 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++)
+ {
+ 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);
}
-void
-Slur::do_pre_processing ()
+MAKE_SCHEME_CALLBACK (Slur, height, 1);
+SCM
+Slur::height (SCM smob)
{
- // don't set directions
+ 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_substitute_dependency (Score_elem*o, Score_elem*n)
+/*
+ Ugh should have dash-length + dash-period
+*/
+MAKE_SCHEME_CALLBACK (Slur, print, 1);
+SCM
+Slur::print (SCM smob)
{
- int i;
- while ((i = encompass_arr_.find_i ((Note_column*)o->item ())) >=0)
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "note-columns", encompasses);
+ if (encompasses.empty ())
{
- if (n)
- encompass_arr_[i] = (Note_column*)n->item ();
- else
- encompass_arr_.del (i);
+ me->suicide ();
+ return SCM_EOL;
}
-}
-static int
-Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
-{
- return Item::left_right_compare (n1, n2);
+ 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;
+
+ /*
+ 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))
+ {
+ 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
+
+ return a.smobbed_copy ();
}
+
+/*
+ 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::do_post_processing ()
+Slur::replace_breakable_encompass_objects (Grob *me)
{
- encompass_arr_.sort (Note_column_compare);
- if (!dir_)
- set_default_dir ();
- Real interline_f = paper ()->interline_f ();
- Real inter_f = interline_f / 2;
-
- /*
- [OSU]: slur and tie placement
-
- slurs:
- * x = centre of head (upside-down: inner raakpunt stem) - d * gap
-
- * 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...
-
- * suggested gap = ss / 5;
- */
- // jcn: 1/5 seems so small?
- Real gap_f = interline_f / 2; // 5;
-
- Drul_array<Note_column*> extrema;
- extrema[LEFT] = encompass_arr_[0];
- extrema[RIGHT] = encompass_arr_.top ();
-
- Direction d=LEFT;
- Real nw_f = paper ()->note_width ();
-
- do
+ extract_grob_set (me, "encompass-objects", extra_objects);
+ vector<Grob *> new_encompasses;
+
+ for (vsize i = 0; i < extra_objects.size (); i++)
{
- if (extrema[d] != spanned_drul_[d])
+ Grob *g = extra_objects[i];
+
+ if (Separation_item::has_interface (g))
{
- dx_f_drul_[d] = -d
- *(spanned_drul_[d]->width ().length () -0.5*nw_f);
+ 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 if (extrema[d]->stem_l_ && !extrema[d]->stem_l_->transparent_b_)
- {
- dy_f_drul_[d] = (int)rint (extrema[d]->stem_l_->height ()[dir_]);
- /* normal slur from notehead centre to notehead centre, minus gap */
- // ugh: diff between old and new slurs
- if (!experimental_features_global_b)
- dx_f_drul_[d] += -d * gap_f;
- else
- dx_f_drul_[d] += 0.5 * nw_f - d * gap_f;
- }
- else
- {
- dy_f_drul_[d] = (int)rint (extrema[d]->head_positions_interval ()[dir_])* inter_f;
- }
- dy_f_drul_[d] += dir_ * interline_f;
+ else
+ new_encompasses.push_back (g);
+ }
+
+ 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;
}
- while (flip(&d) != LEFT);
}
-Real
-Slur::height_f () const
+Bezier
+Slur::get_curve (Grob *me)
{
- Bezier_bow bow (paper ());
- Array<Offset> notes = get_notes ();
- bow.set (notes, dir_);
-
- Real height = 0;
- Real dy1 = bow.calc_f (height);
- if (!dy1)
- return height;
-
- height = dy1;
- bow.set (notes, dir_);
- Real dy2 = bow.calc_f (height);
- if (!dy2)
- return height;
-
- if (abs (dy2 - dy1) < paper ()->rule_thickness ())
- return height;
-
- /*
- Assume
- dy = B (h)
- with
- B (h) = a * h + b;
-
- Then we get for height = h{dy=0}
- */
- Real a = (dy2 - dy1) / dy1;
- Real b = dy1;
- height = -b / a;
-
- if (check_debug && !monitor->silent_b ("Slur"))
- {
- cout << "************" << endl;
- cout << "dy1: " << dy1 << endl;
- cout << "dy2: " << dy2 << endl;
- cout << "a: " << a << endl;
- cout << "b: " << b << endl;
- cout << "h: " << height << endl;
- }
+ 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));
- return height;
+ return b;
}
-Molecule*
-Slur::brew_molecule_p () const
+void
+Slur::add_column (Grob *me, Grob *n)
{
- if (!experimental_features_global_b)
- return Bow::brew_molecule_p ();
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("note-columns"), n);
+ add_bound_item (dynamic_cast<Spanner *> (me), n);
+}
- Molecule* mol_p = new Molecule;
-
- Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
-
- Real dx_f = width ().length ();
- dx_f += (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT]);
-
- Atom a = paper ()->lookup_l ()->control_slur (get_controls (), dx_f, dy_f);
-
- Real interline_f = paper ()->interline_f ();
- Real gap_f = interline_f / 2; // 5;
- Real nw_f = paper ()->note_width ();
- a.translate (Offset (dx_f + 0.5 * nw_f + gap_f, dy_f + dy_f_drul_[LEFT]));
- mol_p->add (a);
- return mol_p;
+void
+Slur::add_extra_encompass (Grob *me, Grob *n)
+{
+ Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
}
-Array<Offset>
-Slur::get_notes () const
+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)
{
- Real interline = paper ()->interline_f ();
- Real notewidth = paper ()->note_width ();
- Real internote = interline / 2;
+ 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);
+}
- Stem* left_stem = encompass_arr_[0]->stem_l_;
- Real left_x = left_stem->hpos_f ();
- // ugh, do bow corrections (see brew_mol)
- left_x += dx_f_drul_[LEFT] + 0.5 * 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"));
- // ugh, do bow corrections (see brew_mol)
- Real left_y = dy_f_drul_[LEFT];
- // ugh, where does this asymmetry come from?
- if (dir_ == DOWN)
- left_y -= dir_ * internote;
+ if (!slur)
+ return offset_scm;
- /*
- urg, corrections for broken slurs: extra begin or end position
- */
- int first = 0;
- int n = encompass_arr_.size ();
- if (encompass_arr_[0] != spanned_drul_[LEFT])
- {
- n += 1;
- first = 1;
- left_x = spanned_drul_[LEFT]->width ().length ();
- left_y = 0;
- }
- if (encompass_arr_.top () != spanned_drul_[RIGHT])
- n += 1;
-
- Array<Offset> notes;
- notes.set_size (n);
-
- Real dx = width ().length ();
- dx += (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT]);
- dx = dx <? 1000;
- dx = dx >? 2 * interline;
-
- Real dy = (dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
- if (abs (dy) > 1000)
- dy = sign (dy) * 1000;
-
- notes[0].x () = 0;
- notes[0].y () = 0;
- notes[n - 1].x () = dx;
- notes[n - 1].y () = dy;
- for (int i = 1; i < n - 1; i++)
+ 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;
+
+ Grob *cx = script->common_refpoint (slur, X_AXIS);
+ Grob *cy = script->common_refpoint (slur, Y_AXIS);
+
+ Bezier curve = Slur::get_curve (slur);
+
+ 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);
+
+ 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);
+
+ 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++)
{
- Stem* stem = encompass_arr_[i - first]->stem_l_;
- /*
- set x to middle of notehead or on exact x position of stem,
- according to slur direction
- */
- Real x = stem->hpos_f () - left_x + notewidth / 2;
- if (stem->dir_ != dir_)
- x += notewidth / 2;
- else if (stem->dir_ == UP)
- x += notewidth;
- Real y = stem->dir_ == dir_ ? stem->stem_end_f ()
- : stem->stem_begin_f () + 2.5 * dir_;
-
- /*
- leave a gap: slur mustn't touch head/stem
- */
- y += 2.5 * dir_;
- y *= internote;
- y -= left_y;
-
- notes[i].x () = x;
- notes[i].y () = y;
+ 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));
+
+ /* 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<Offset>
-Slur::get_controls () 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)
{
- Bezier_bow b (paper ());
- b.set (get_notes (), dir_);
- b.calc ();
- Array<Offset> controls;
- controls.set_size (8);
- for (int i = 0; i < 4; i++)
- controls[i] = b.control_[i];
- for (int i = 0; i < 4; i++)
- controls[i + 4] = b.return_[i];
- return controls;
+ 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];
+
+ 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