]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur.cc
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / slur.cc
index a18495ba91970c0a0247eff46ed2ffe004a48875..3b26af8bebabb63b83ba8c965cbf5687e45b696d 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
-
-#include <math.h>
-
+#include "slur.hh"
+#include "grob-info.hh"
+#include "grob-array.hh"
+#include "beam.hh"
 #include "bezier.hh"
-#include "new-slur.hh"
-#include "main.hh"
-#include "font-interface.hh"
-#include "text-item.hh"
 #include "directional-element-interface.hh"
-#include "group-interface.hh"
-#include "lily-guile.hh"
+#include "font-interface.hh"
+#include "pointer-group-interface.hh"
 #include "lookup.hh"
+#include "main.hh"             // DEBUG_SLUR_SCORING
 #include "note-column.hh"
 #include "output-def.hh"
-#include "rod.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
 #include "staff-symbol.hh"
 #include "stem.hh"
-#include "stencil.hh"
+#include "text-interface.hh"
+#include "tie.hh"
 #include "warn.hh"
-#include "beam.hh"
+#include "slur-scoring.hh"
+#include "separation-item.hh"
+#include "script-interface.hh"
+
+
 
-MAKE_SCHEME_CALLBACK (New_slur, height, 2);
+MAKE_SCHEME_CALLBACK(Slur, calc_direction, 1)
 SCM
-New_slur::height (SCM smob, SCM ax)
+Slur::calc_direction (SCM smob)
 {
-  Axis a = (Axis)ly_scm2int (ax);
   Grob *me = unsmob_grob (smob);
-  assert (a == Y_AXIS);
+  extract_grob_set (me, "note-columns", encompasses);
 
-  SCM mol = me->get_uncached_stencil ();
-  Interval ext;
-  if (Stencil *m = unsmob_stencil (mol))
-    ext = m->extent (a);
-  return ly_interval2scm (ext);
+  if (encompasses.empty ())
+    {
+      me->suicide ();
+      return SCM_BOOL_F;
+    }
+
+  Direction d = DOWN;
+  for (vsize i = 0; i < encompasses.size (); i++)
+    {
+      if (Note_column::dir (encompasses[i]) < 0)
+       {
+         d = UP;
+         break;
+       }
+    }
+  return scm_from_int (d);
+}
+
+MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
+SCM
+Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
+{
+  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);
+}
+
+MAKE_SCHEME_CALLBACK (Slur, height, 1);
+SCM
+Slur::height (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+
+  // FIXME uncached
+  Stencil *m = me->get_stencil ();
+  return m ? ly_interval2scm (m->extent (Y_AXIS))
+    : ly_interval2scm (Interval ());
 }
 
 /*
   Ugh should have dash-length + dash-period
 */
-MAKE_SCHEME_CALLBACK (New_slur, print,1);
+MAKE_SCHEME_CALLBACK (Slur, print, 1);
 SCM
-New_slur::print (SCM smob)
+Slur::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  if (!scm_ilength (me->get_property ("note-columns")))
+  extract_grob_set (me, "note-columns", encompasses);
+  if (encompasses.empty ())
     {
       me->suicide ();
       return SCM_EOL;
     }
 
-  Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
-  Real thick = base_thick * Staff_symbol_referencer::line_thickness (me);
+  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);
 
-  Real ss = Staff_symbol_referencer::staff_space (me);
   Bezier one = get_curve (me);
-
   Stencil a;
 
   /*
     TODO: replace dashed with generic property.
   */
-  SCM d =  me->get_property ("dashed");
-  if (ly_c_number_p (d))
-    a = Lookup::dashed_slur (one, thick, thick * robust_scm2double (d, 0));
+  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 * ss / 10.0,
-                     thick);
+    a = Lookup::slur (one,
+                     get_grob_direction (me) * base_thick,
+                     line_thick);
 
-#if DEBUG_SLUR_QUANTING
+#if DEBUG_SLUR_SCORING
   SCM quant_score = me->get_property ("quant-score");
 
-  if (to_boolean (me->get_paper ()
-                 ->lookup_variable (ly_symbol2scm ("debug-slur-quanting")))
-      && ly_c_string_p (quant_score))
+  if (to_boolean (me->layout ()
+                 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
+      && scm_is_string (quant_score))
     {
-      String str;
+      string str;
       SCM properties = Font_interface::text_font_alist_chain (me);
 
-      Stencil tm = *unsmob_stencil (Text_item::interpret_markup
-                                   (me->get_paper ()->self_scm (), properties,
+
+      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);
+      a.add_at_edge (Y_AXIS, get_grob_direction (me), tm, 1.0);
     }
 #endif
 
@@ -98,51 +161,109 @@ New_slur::print (SCM smob)
 }
 
 
+/*
+  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++)
+    {
+      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 (breakables[j]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
+             new_encompasses.push_back (breakables[j]);
+       }
+      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;
+    }
+}
+
 Bezier
-New_slur::get_curve (Grob*me)
+Slur::get_curve (Grob *me)
 {
   Bezier b;
   int i = 0;
-  for (SCM s = me->get_property ("control-points"); s != SCM_EOL;
-       s = ly_cdr (s))
-    b.control_[i++] = ly_scm2offset (ly_car (s));
+  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 b;
 }
 
 void
-New_slur::add_column (Grob*me, Grob*n)
+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), dynamic_cast<Item*> (n));
+  add_bound_item (dynamic_cast<Spanner *> (me), n);
 }
 
-
 void
-New_slur::add_extra_encompass (Grob*me, Grob*n)
+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;
 
-MAKE_SCHEME_CALLBACK (New_slur, outside_slur_callback, 2);
+  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);
+}
+
+MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Slur, outside_slur_callback, 2, 1, "");
 SCM
-New_slur::outside_slur_callback (SCM grob, SCM axis)
+Slur::outside_slur_callback (SCM grob, SCM offset_scm)
 {
   Grob *script = unsmob_grob (grob);
-  Axis a = Axis (ly_scm2int (axis));
-  assert (a == Y_AXIS);
-
-  Grob *slur = unsmob_grob (script->get_property ("slur"));
+  Grob *slur = unsmob_grob (script->get_object ("slur")); 
 
   if (!slur)
-    return scm_from_int (0);
+    return offset_scm;
+
+  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 = New_slur::get_curve (slur);
+  Bezier curve = Slur::get_curve (slur);
 
   curve.translate (Offset (slur->relative_coordinate (cx, X_AXIS),
                           slur->relative_coordinate (cy, Y_AXIS)));
@@ -150,34 +271,127 @@ New_slur::outside_slur_callback (SCM grob, SCM axis)
   Interval yext = robust_relative_extent (script, cy, Y_AXIS);
   Interval xext = robust_relative_extent (script, cx, X_AXIS);
 
-
-  Real slur_padding = 0.2;     // todo: slur property, script property?
-  yext.widen (slur_padding);
+  Real offset = robust_scm2double (offset_scm, 0);
+  yext.translate (offset);
   
-  Interval bezext (curve.control_[0][X_AXIS],
-                  curve.control_[3][X_AXIS]);
+  /* FIXME: slur property, script property?  */
+  Real slur_padding = robust_scm2double (script->get_property ("slur-padding"),
+                                        0.0);
+  yext.widen (slur_padding);
 
-  Real x = xext.center ();
-  if (!bezext.contains (xext[RIGHT]))
-    x = xext[LEFT];
-  else if (!bezext.contains (xext[LEFT]))
-    x = xext[RIGHT];
+  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++)
+    {
+      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;
+       }
+    }
 
+  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)));
   
-  if (!bezext.contains (x))
-    return scm_make_real (0);
+  return scm_from_double (offset + avoidance_offset);
+}
 
-  Real y = curve.get_other_coordinate (X_AXIS, x);
-  if (yext.contains (y)) 
+/*
+ * 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)
+{
+  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"))
     {
-      Direction dir = get_grob_direction (script); 
-      return scm_make_real (y - yext[-dir] + dir * slur_padding);
+      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);
     }
-  return scm_make_real (0.0);
+  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?");
 }
 
+MAKE_SCHEME_CALLBACK (Slur, cross_staff, 1)
+SCM
+Slur::cross_staff (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
+  assert (staff); // delete me
+  extract_grob_set (me, "note-columns", cols);
+
+  for (vsize i = 0; i < cols.size (); i++)
+    if (Staff_symbol_referencer::get_staff_symbol (cols[i]) != staff)
+      return SCM_BOOL_T;
+  return SCM_BOOL_F;
+}
 
-ADD_INTERFACE (New_slur, "new-slur-interface",
+ADD_INTERFACE (Slur,
+              
               "A slur",
-              "excentricity encompass-objects control-points dashed slur-details direction height-limit note-columns ratio thickness");
+              
+              /* 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 "
+              );