]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur-scoring.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / slur-scoring.cc
index 400e08a9a82726370043aa34deb074f2c4fb8c3b..57fa3c6183e4a938c83921cc5b3c3ec9050abbf5 100644 (file)
@@ -3,18 +3,17 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
-#include <math.h>
 
 #include "slur-scoring.hh"
 #include "libc-extension.hh"
 #include "slur-configuration.hh"
 #include "beam.hh"
 #include "directional-element-interface.hh"
-#include "group-interface.hh"
+#include "pointer-group-interface.hh"
 #include "slur.hh"
 #include "note-column.hh"
 #include "output-def.hh"
@@ -32,8 +31,6 @@
 
   - curve around flag for y coordinate
 
-  - this file is a mess, clean it up
-
   - short-cut: try a smaller region first.
 
   - handle non-visible stems better.
@@ -80,7 +77,7 @@ get_detail (SCM alist, SCM sym)
 void
 Slur_score_parameters::fill (Grob *me)
 {
-  SCM details = me->get_property ("slur-details");
+  SCM details = me->get_property ("details");
 
   region_size_
     = (int) get_detail (details, ly_symbol2scm ("region-size"));
@@ -106,8 +103,8 @@ Slur_score_parameters::fill (Grob *me)
     = get_detail (details, ly_symbol2scm ("free-head-distance"));
   absolute_closeness_measure_
     = get_detail (details, ly_symbol2scm ("absolute-closeness-measure"));
-  extra_object_collision_
-    = get_detail (details, ly_symbol2scm ("extra-object-collision"));
+  extra_object_collision_penalty_
+    = get_detail (details, ly_symbol2scm ("extra-object-collision-penalty"));
   accidental_collision_
     = get_detail (details, ly_symbol2scm ("accidental-collision"));
   extra_encompass_free_distance_
@@ -128,7 +125,7 @@ broken_trend_y (Slur_score_state const &state, Direction hdir)
   /* A broken slur should maintain the same vertical trend
      the unbroken slur would have had.  */
   Real by = 0.0;
-  if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original_))
+  if (Spanner *mother = dynamic_cast<Spanner *> (state.slur_->original ()))
     {
       int k = broken_spanner_index (state.slur_);
       int j = k + hdir;
@@ -137,7 +134,7 @@ broken_trend_y (Slur_score_state const &state, Direction hdir)
 
       Grob *neighbor = mother->broken_intos_[j];
       Spanner *common_mother
-       = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original_);
+       = dynamic_cast<Spanner *> (state.common_[Y_AXIS]->original ());
       int common_k
        = broken_spanner_index (dynamic_cast<Spanner *> (state.common_[Y_AXIS]));
       int common_j = common_k + hdir;
@@ -164,7 +161,7 @@ Slur_score_state::set_next_direction ()
   if (extremes_[RIGHT].note_column_)
     return;
 
-  if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original_))
+  if (Spanner *mother = dynamic_cast<Spanner *> (slur_->original ()))
     {
       int k = broken_spanner_index (slur_);
       int j = k + 1;
@@ -179,7 +176,7 @@ Slur_score_state::set_next_direction ()
 Encompass_info
 Slur_score_state::get_encompass_info (Grob *col) const
 {
-  Grob *stem = unsmob_grob (col->get_property ("stem"));
+  Grob *stem = unsmob_grob (col->get_object ("stem"));
   Encompass_info ei;
 
   if (!stem)
@@ -239,27 +236,41 @@ Slur_score_state::get_bound_info () const
        {
          extremes[d].note_column_ = extremes[d].bound_;
          extremes[d].stem_ = Note_column::get_stem (extremes[d].note_column_);
-         extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
-         extremes[d].stem_extent_[X_AXIS]
-           = extremes[d].stem_->extent (common_[X_AXIS], X_AXIS);
-         extremes[d].stem_extent_[Y_AXIS]
-           = extremes[d].stem_->extent (common_[Y_AXIS], Y_AXIS);
-         extremes[d].slur_head_
-           = Stem::extremal_heads (extremes[d].stem_)[dir];
-         if (!extremes[d].slur_head_
-             && Note_column::has_rests (extremes[d].bound_))
+         if (extremes[d].stem_)
            {
-             extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
+             extremes[d].stem_dir_ = get_grob_direction (extremes[d].stem_);
+
+             for (int a = X_AXIS; a < NO_AXES; a++)
+               {
+                 Axis ax = Axis (a);
+                 Interval s = extremes[d].stem_->extent (common_[ax], ax);
+                 if (s.is_empty ())
+                   {
+                     /*
+                       do not issue warning. This happens for rests and
+                       whole notes.
+                     */
+                     s = Interval (0, 0)
+                       + extremes[d].stem_->relative_coordinate (common_[ax], ax);
+                   }
+                 extremes[d].stem_extent_[ax] = s;
+               }
+
+             extremes[d].slur_head_
+               = Stem::extremal_heads (extremes[d].stem_)[dir];
+             if (!extremes[d].slur_head_
+                 && Note_column::has_rests (extremes[d].bound_))
+               extremes[d].slur_head_ = Note_column::get_rest (extremes[d].bound_);
+             extremes[d].staff_ = Staff_symbol_referencer
+               ::get_staff_symbol (extremes[d].stem_);
+             extremes[d].staff_space_ = Staff_symbol_referencer
+               ::staff_space (extremes[d].stem_);
            }
 
          if (extremes[d].slur_head_)
-           extremes[d].slur_head_extent_
+           extremes[d].slur_head_x_extent_
              = extremes[d].slur_head_->extent (common_[X_AXIS], X_AXIS);
 
-         extremes[d].staff_ = Staff_symbol_referencer
-           ::get_staff_symbol (extremes[d].stem_);
-         extremes[d].staff_space_ = Staff_symbol_referencer
-           ::staff_space (extremes[d].stem_);
        }
     }
   while (flip (&d) != LEFT);
@@ -272,7 +283,7 @@ Slur_score_state::fill (Grob *me)
 {
   slur_ = dynamic_cast<Spanner *> (me);
   columns_
-    = extract_grob_array (me, ly_symbol2scm ("note-columns"));
+    = internal_extract_grob_array (me, ly_symbol2scm ("note-columns"));
 
   if (columns_.is_empty ())
     {
@@ -281,21 +292,22 @@ Slur_score_state::fill (Grob *me)
     }
 
   staff_space_ = Staff_symbol_referencer::staff_space (me);
-  Real lt = me->get_layout ()->get_dimension (ly_symbol2scm ("linethickness"));
+  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("linethickness"));
   thickness_ = robust_scm2double (me->get_property ("thickness"), 1.0) * lt;
 
   dir_ = get_grob_direction (me);
   parameters_.fill (me);
 
-  SCM eltlist = me->get_property ("note-columns");
-  SCM extra_list = me->get_property ("encompass-objects");
+  extract_grob_set (me, "note-columns", columns);
+  extract_grob_set (me, "encompass-objects", extra_objects);
+
   Spanner *sp = dynamic_cast<Spanner *> (me);
 
   for (int i = X_AXIS; i < NO_AXES; i++)
     {
       Axis a = (Axis)i;
-      common_[a] = common_refpoint_of_list (eltlist, me, a);
-      common_[a] = common_refpoint_of_list (extra_list, common_[a], a);
+      common_[a] = common_refpoint_of_array (columns, me, a);
+      common_[a] = common_refpoint_of_array (extra_objects, common_[a], a);
 
       Direction d = LEFT;
       do
@@ -334,7 +346,8 @@ Slur_score_state::fill (Grob *me)
   Direction d = LEFT;
   do
     {
-      if (!is_broken_)
+      if (!is_broken_
+         && extremes_[d].slur_head_)
        musical_dy_ += d
          * extremes_[d].slur_head_->relative_coordinate (common_[Y_AXIS], Y_AXIS);
     }
@@ -350,14 +363,18 @@ Slur_score_state::fill (Grob *me)
     musical_dy_ = 0.0;
 }
 
-void
-set_slur_control_points (Grob *me)
+
+MAKE_SCHEME_CALLBACK(Slur, calc_control_points, 1)
+SCM
+Slur::calc_control_points (SCM smob)
 {
+  Spanner *me = unsmob_spanner (smob);
+
   Slur_score_state state;
   state.fill (me);
 
   if (!state.valid_)
-    return;
+    return SCM_EOL;
 
   state.generate_curves ();
 
@@ -365,13 +382,9 @@ set_slur_control_points (Grob *me)
   Bezier best;
 
   if (is_number_pair (end_ys))
-    {
-      best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
-    }
+    best = state.configurations_[state.get_closest_index (end_ys)]->curve_;
   else
-    {
-      best = state.get_best_curve ();
-    }
+    best = state.get_best_curve ();
 
   SCM controls = SCM_EOL;
   for (int i = 4; i--;)
@@ -381,35 +394,42 @@ set_slur_control_points (Grob *me)
                  me->relative_coordinate (state.common_[Y_AXIS], Y_AXIS));
       controls = scm_cons (ly_offset2scm (o), controls);
     }
-  me->set_property ("control-points", controls);
+
+  return controls;
 }
 
 Bezier
 Slur_score_state::get_best_curve ()
 {
-  for (int i = 0; i < configurations_.size (); i++)
+  int opt_idx = -1;
+  Real opt = 1e6;
+
+#if DEBUG_SLUR_SCORING
+  SCM inspect_quants = slur_->get_property ("inspect-quants");
+  if (to_boolean (slur_->layout ()
+                 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
+      && scm_is_pair (inspect_quants))
     {
-      configurations_[i]->score (*this);
+      opt_idx = get_closest_index (inspect_quants);
+      configurations_[opt_idx]->score (*this);
+      opt = configurations_[opt_idx]->score_;
     }
-
-  Real opt = 1e6;
-  int opt_idx = -1;
-  for (int i = 0; i < configurations_.size (); i++)
+  else
+#endif
     {
-      if (configurations_[i]->score_ < opt)
+      for (int i = 0; i < configurations_.size (); i++)
+       configurations_[i]->score (*this);
+      for (int i = 0; i < configurations_.size (); i++)
        {
-         opt = configurations_[i]->score_;
-         opt_idx = i;
+         if (configurations_[i]->score_ < opt)
+           {
+             opt = configurations_[i]->score_;
+             opt_idx = i;
+           }
        }
     }
 
 #if DEBUG_SLUR_SCORING
-  SCM inspect_quants = slur_->get_property ("inspect-quants");
-  if (to_boolean (slur_->get_layout ()
-                 ->lookup_variable (ly_symbol2scm ("debug-slur-scoring")))
-      && scm_is_pair (inspect_quants))
-    opt_idx = get_closest_index (inspect_quants);
-
   configurations_[opt_idx]->score_card_ += to_string ("=%.2f", opt);
   configurations_[opt_idx]->score_card_ += to_string ("i%d", opt_idx);
 
@@ -459,10 +479,10 @@ Slur_score_state::get_y_attachment_range () const
       if (extremes_[d].note_column_)
        {
          end_ys[d] = dir_
-           * ((dir_ * (base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_))
-              >? (dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS],
-                                                                    Y_AXIS)[dir_]))
-              >? (dir_ * base_attachments_[-d][Y_AXIS]));
+           * max (max (dir_ * (base_attachments_[d][Y_AXIS]
+                                         + parameters_.region_size_ * dir_),
+                       dir_ * (dir_ + extremes_[d].note_column_->extent (common_[Y_AXIS], Y_AXIS)[dir_])),
+                  dir_ * base_attachments_[-d][Y_AXIS]);
        }
       else
        end_ys[d] = base_attachments_[d][Y_AXIS] + parameters_.region_size_ * dir_;
@@ -479,8 +499,8 @@ spanner_less (Spanner *s1, Spanner *s2)
   Direction d = LEFT;
   do
     {
-      b1[d] = s1->get_bound (d)->get_column ()->rank_;
-      b2[d] = s2->get_bound (d)->get_column ()->rank_;
+      b1[d] = s1->get_bound (d)->get_column ()->get_rank ();
+      b2[d] = s2->get_bound (d)->get_column ()->get_rank ();
     }
   while (flip (&d) != LEFT);
 
@@ -535,13 +555,9 @@ Slur_score_state::get_base_attachments () const
        {
          Real x, y;
          if (d == RIGHT)
-           {
-             x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
-           }
+           x = extremes_[d].bound_->extent (common_[X_AXIS], X_AXIS)[d];
          else
-           {
-             x = slur_->get_broken_left_end_align ();
-           }
+           x = slur_->get_broken_left_end_align ();
          Grob *col = (d == LEFT) ? columns_[0] : columns_.top ();
 
          if (extremes_[-d].bound_ != col)
@@ -564,7 +580,6 @@ Slur_score_state::get_base_attachments () const
     }
   while (flip (&d) != LEFT);
 
-
   do
     {
       for (int a = X_AXIS; a < NO_AXES; a++)
@@ -576,12 +591,10 @@ Slur_score_state::get_base_attachments () const
              programming_error ("slur attachment is inf/nan");
              b = 0.0;
            }
-           
        }
     }
   while (flip (&d) != LEFT);
-  
-  
+
   return base_attachment;
 }
 
@@ -589,9 +602,16 @@ Real
 Slur_score_state::move_away_from_staffline (Real y,
                                            Grob *on_staff) const
 {
+  if (!on_staff)
+    return y;
+  
+  Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (on_staff);
+  if (!staff_symbol)
+    return y;
+
   Real pos
-    = (y - Staff_symbol_referencer::get_staff_symbol (on_staff)->relative_coordinate (common_[Y_AXIS],
-                                                                                     Y_AXIS))
+    = (y - staff_symbol->relative_coordinate (common_[Y_AXIS],
+                                             Y_AXIS))
     * 2.0 / staff_space_;
 
   if (fabs (pos - my_round (pos)) < 0.2
@@ -602,13 +622,62 @@ Slur_score_state::move_away_from_staffline (Real y,
   return y;
 }
 
+Array<Offset>
+Slur_score_state::generate_avoid_offsets () const
+{
+  Array<Offset> avoid;
+  Link_array<Grob> encompasses = columns_;
+
+  for (int i = 0; i < encompasses.size (); i++)
+    {
+      if (extremes_[LEFT].note_column_ == encompasses[i]
+         || extremes_[RIGHT].note_column_ == encompasses[i])
+       continue;
+
+      Encompass_info inf (get_encompass_info (encompasses[i]));
+      Real y = dir_ * (max (dir_ * inf.head_, dir_ * inf.stem_));
+
+      avoid.push (Offset (inf.x_, y + dir_ * parameters_.free_head_distance_));
+    }
+
+  extract_grob_set (slur_, "encompass-objects", extra_encompasses);
+  for (int i = 0; i < extra_encompasses.size (); i++)
+    {
+      if (Slur::has_interface (extra_encompasses[i]))
+       {
+         Grob *small_slur = extra_encompasses[i];
+         Bezier b = Slur::get_curve (small_slur);
+
+         Offset z = b.curve_point (0.5);
+         z += Offset (small_slur->relative_coordinate (common_[X_AXIS], X_AXIS),
+                      small_slur->relative_coordinate (common_[Y_AXIS], Y_AXIS));
+
+         z[Y_AXIS] += dir_ * parameters_.free_slur_distance_;
+         avoid.push (z);
+       }
+      else if (extra_encompasses[i]->get_property ("avoid-slur") == ly_symbol2scm ("inside"))
+       {
+         Grob *g = extra_encompasses [i];
+         Interval xe = g->extent (common_[X_AXIS], X_AXIS);
+         Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
+
+         if (!xe.is_empty ()
+             && !ye.is_empty ())
+           avoid.push (Offset (xe.center(), ye[dir_]));
+       }
+    }  
+  return avoid;
+}
+
 void
 Slur_score_state::generate_curves () const
 {
   Real r_0 = robust_scm2double (slur_->get_property ("ratio"), 0.33);
   Real h_inf = staff_space_ * scm_to_double (slur_->get_property ("height-limit"));
+
+  Array<Offset> avoid = generate_avoid_offsets ();
   for (int i = 0; i < configurations_.size (); i++)
-    configurations_[i]->generate_curve (*this, r_0, h_inf);
+    configurations_[i]->generate_curve (*this, r_0, h_inf, avoid);
 }
 
 Link_array<Slur_configuration>
@@ -660,9 +729,10 @@ Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
            {
              do
                {
-                 if (extremes_[d].slur_head_)
+                 if (extremes_[d].slur_head_
+                     && !extremes_[d].slur_head_x_extent_.is_empty ())
                    {
-                     os[d][X_AXIS] = extremes_[d].slur_head_extent_.center ();
+                     os[d][X_AXIS] = extremes_[d].slur_head_x_extent_.center ();
                      attach_to_stem[d] = false;
                    }
                }
@@ -680,7 +750,7 @@ Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
 
                     TODO: parameter */
                  os[d][X_AXIS]
-                   -= dir_ * extremes_[d].slur_head_extent_.length ()
+                   -= dir_ * extremes_[d].slur_head_x_extent_.length ()
                    * sin (dz.arg ()) / 3;
                }
            }
@@ -704,8 +774,7 @@ Slur_score_state::enumerate_attachments (Drul_array<Real> end_ys) const
 Array<Extra_collision_info>
 Slur_score_state::get_extra_encompass_infos () const
 {
-  Link_array<Grob> encompasses
-    = extract_grob_array (slur_, ly_symbol2scm ("encompass-objects"));
+  extract_grob_set (slur_, "encompass-objects", encompasses);
   Array<Extra_collision_info> collision_infos;
   for (int i = encompasses.size (); i--;)
     {
@@ -741,7 +810,7 @@ Slur_score_state::get_extra_encompass_infos () const
                                         k - 1.0,
                                         xext,
                                         yext,
-                                        parameters_.extra_object_collision_);
+                                        parameters_.extra_object_collision_penalty_);
              collision_infos.push (info);
            }
        }
@@ -752,7 +821,7 @@ Slur_score_state::get_extra_encompass_infos () const
          Interval ye = g->extent (common_[Y_AXIS], Y_AXIS);
 
          Real xp = 0.0;
-         Real penalty = parameters_.extra_object_collision_;
+         Real penalty = parameters_.extra_object_collision_penalty_;
          if (Accidental_interface::has_interface (g))
            {
              penalty = parameters_.accidental_collision_;
@@ -761,7 +830,7 @@ Slur_score_state::get_extra_encompass_infos () const
              if (to_boolean (g->get_property ("cautionary")))
                {
                  SCM cstyle = g->get_property ("cautionary-style");
-                 parens = ly_c_equal_p (cstyle, ly_symbol2scm ("parentheses"));
+                 parens = ly_is_equal (cstyle, ly_symbol2scm ("parentheses"));
                }
 
              SCM accs = g->get_property ("accidentals");
@@ -796,4 +865,21 @@ Slur_score_state::get_extra_encompass_infos () const
 
   return collision_infos;
 }
+Extra_collision_info::Extra_collision_info (Grob *g, Real idx, Interval x, Interval y, Real p)
+{
+  idx_ = idx;
+  extents_[X_AXIS] = x;
+  extents_[Y_AXIS] = y;
+  penalty_ = p;
+  grob_ = g;
+  type_ = g->get_property ("avoid-slur");
+}
 
+Extra_collision_info::Extra_collision_info ()
+{
+  idx_ = 0.0;
+  penalty_ = 0.;
+  grob_ = 0;
+  type_ = SCM_EOL; 
+}