]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur.cc
Better approximations for cross-staff slurs
[lilypond.git] / lily / slur.cc
index bf0fb12361e80298aa5f68a2ad9807dc2a69d692..aec1e04266a49421589f0cb331a65cc10f5f2321 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1996--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 
   LilyPond is free software: you can redistribute it and/or modify
@@ -31,6 +31,7 @@
 #include "main.hh"              // DEBUG_SLUR_SCORING
 #include "note-column.hh"
 #include "output-def.hh"
+#include "skyline-pair.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
 #include "stem.hh"
@@ -70,15 +71,26 @@ MAKE_SCHEME_CALLBACK (Slur, pure_height, 3);
 SCM
 Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
 {
+  /*
+    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 = 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);
+  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 */
@@ -88,13 +100,31 @@ Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
     {
       Interval d = encompasses[i]->pure_height (parent, start, end);
       if (!d.is_empty ())
-        ret.unite (d);
+        {
+          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];
+        }
     }
 
-  // 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.widen (height * 0.5 + 0.5);
+  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]);
+
+  /*
+    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);
 }
 
@@ -115,6 +145,7 @@ SCM
 Slur::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
+
   extract_grob_set (me, "note-columns", encompasses);
   if (encompasses.empty ())
     {
@@ -221,6 +252,25 @@ Slur::add_extra_encompass (Grob *me, Grob *n)
   Pointer_group_interface::add_grob (me, ly_symbol2scm ("encompass-objects"), n);
 }
 
+void
+Slur::main_to_stub (Grob *main, Grob *stub)
+{
+  extract_grob_set (main, "note-columns", nc);
+  for (vsize i = 0; i < nc.size (); i++)
+    add_column (stub, nc[i]);
+
+  extract_grob_set (main, "encompass-objects", eo);
+  for (vsize i = 0; i < eo.size (); i++)
+    add_extra_encompass (stub, eo[i]);
+
+  stub->set_object ("surrogate", main->self_scm ());
+
+  dynamic_cast<Spanner *> (stub)->set_bound
+    (LEFT, dynamic_cast<Spanner *> (main)->get_bound (LEFT));
+  dynamic_cast<Spanner *> (stub)->set_bound
+    (RIGHT, dynamic_cast<Spanner *> (main)->get_bound (RIGHT));
+}
+
 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)
@@ -280,10 +330,8 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
     return offset_scm;
 
   bool contains = false;
-  Direction d = LEFT;
-  do
+  for (LEFT_and_RIGHT (d))
     contains |= slur_wid.contains (xext[d]);
-  while (flip (&d) != LEFT);
 
   if (!contains)
     return offset_scm;
@@ -301,8 +349,7 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
   Real EPS = 1.0e-5;
   if (avoid == ly_symbol2scm ("outside"))
     {
-      Direction d = LEFT;
-      do
+      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);
@@ -310,14 +357,12 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
           if (do_shift)
             break;
         }
-      while (flip (&d) != LEFT);
     }
   else
     {
       for (int a = X_AXIS; a < NO_AXES; a++)
         {
-          Direction d = LEFT;
-          do
+          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++)
@@ -329,7 +374,6 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
               if (do_shift)
                 break;
             }
-          while (flip (&d) != LEFT);
           if (do_shift)
             break;
         }
@@ -340,36 +384,98 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
   return scm_from_double (offset + avoidance_offset);
 }
 
+MAKE_SCHEME_CALLBACK (Slur, vertical_skylines, 1);
+SCM
+Slur::vertical_skylines (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  vector<Box> boxes;
+
+  if (!me)
+    return Skyline_pair (boxes, X_AXIS).smobbed_copy ();
+
+  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++)
+    {
+      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);
+    }
+
+  return Skyline_pair (boxes, X_AXIS).smobbed_copy ();
+}
+
+/*
+ * USE ME ONLY FOR CROSS STAFF SLURS!
+ * We only want to keep the topmost skyline of the topmost axis group(s)
+ * and the bottommost skyline of the bottommost axis group(s). Otherwise,
+ * the VerticalAxisGroups will be spaced very far apart to accommodate the
+ * slur, which we don't want, as it is cross staff.
+ *
+ * TODO: Currently, the code below keeps the topmost and bottommost axis
+ * groups and gets rid of the rest.  This should be more nuanced for
+ * cases like ossias where the topmost staff changes over the course of
+ * the slur.  Ditto for the bottommost staff.
+ */
+
+MAKE_SCHEME_CALLBACK (Slur, extremal_stub_vertical_skylines, 1);
+SCM
+Slur::extremal_stub_vertical_skylines (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Grob *my_vag = Grob::get_vertical_axis_group (me);
+  extract_grob_set (me, "note-columns", ro_note_columns);
+  vector<Grob *> note_columns (ro_note_columns);
+  vector_sort (note_columns, Grob::vertical_less);
+  bool highest = my_vag == Grob::get_vertical_axis_group (note_columns[0]);
+  bool lowest = my_vag == Grob::get_vertical_axis_group (note_columns.back ());
+  if (!highest && !lowest)
+    return Skyline_pair ().smobbed_copy ();
+
+  Skyline_pair sky = *Skyline_pair::unsmob (vertical_skylines (smob));
+
+  if (highest)
+    sky[DOWN] = Skyline (DOWN);
+  else
+    sky[UP] = Skyline (UP);
+
+  return sky.smobbed_copy ();
+}
+
 /*
  * 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)
+                                          vector<Slur_info> &slur_infos,
+                                          vector<Slur_info> &end_slur_infos)
 {
-  if (slurs.empty () && end_slurs.empty ())
+  if (slur_infos.empty () && end_slur_infos.empty ())
     return;
 
   Grob *e = info.grob ();
   SCM avoid = e->get_property ("avoid-slur");
+  Grob *slur;
+  if (end_slur_infos.size () && !slur_infos.size ())
+    slur = end_slur_infos[0].slur_;
+  else
+    slur = slur_infos[0].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);
+      for (vsize i = slur_infos.size (); i--;)
+        add_extra_encompass (slur_infos[i].slur_, e);
+      for (vsize i = end_slur_infos.size (); i--;)
+        add_extra_encompass (end_slur_infos[i].slur_, e);
+      if (slur)
+        e->set_object ("slur", slur->self_scm ());
     }
   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);
@@ -378,7 +484,7 @@ Slur::auxiliary_acknowledge_extra_object (Grob_info const &info,
         }
     }
   else if (avoid != ly_symbol2scm ("ignore"))
-    e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?",
+    e->warning (_f ("Ignoring grob for slur: %s.  avoid-slur not set?",
                     e->name ().c_str ()));
 }