]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam-quanting.cc
* lily/lexer.ll: change is_string -> ly_c_string_p
[lilypond.git] / lily / beam-quanting.cc
index 54b308f326704bdc038b8e33ed74c5b3ef430597..3a7503bcaa015b71f643242433b3225d9417dfac 100644 (file)
@@ -3,9 +3,11 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
   
+
+  
 */
 
 
@@ -25,11 +27,18 @@ const int INTER_QUANT_PENALTY = 1000;
 const Real SECONDARY_BEAM_DEMERIT  = 10.0;
 const int STEM_LENGTH_DEMERIT_FACTOR = 5;
 
+/*
+  threshold to combat rounding errors.
+ */
+const Real BEAM_EPS = 1e-3; 
+
 // possibly ridiculous, but too short stems just won't do
 const int STEM_LENGTH_LIMIT_PENALTY = 5000;
-const int DAMPING_DIRECTIION_PENALTY = 800;
+const int DAMPING_DIRECTION_PENALTY = 800;
 const int MUSICAL_DIRECTION_FACTOR = 400;
 const int IDEAL_SLOPE_FACTOR = 10;
+const Real ROUND_TO_ZERO_SLOPE = 0.02;
+const int ROUND_TO_ZERO_POINTS = 4;
 
 extern bool debug_beam_quanting_flag;
 
@@ -86,17 +95,22 @@ Beam::quanting (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
 
-  SCM s = me->get_grob_property ("positions");
-  Real yl = gh_scm2double (gh_car (s));
-  Real yr = gh_scm2double (gh_cdr (s));
+  SCM s = me->get_property ("positions");
+  Real yl = ly_scm2double (ly_car (s));
+  Real yr = ly_scm2double (ly_cdr (s));
 
-  Real ss = Staff_symbol_referencer::staff_space (me);
-  Real thickness = gh_scm2double (me->get_grob_property ("thickness")) / ss;
-  Real slt = me->get_paper ()->get_realvar (ly_symbol2scm ("linethickness")) / ss;
 
+  /*
+    Calculations are relative to a unit-scaled staff, i.e. the quants are
+    divided by the current staff_space.
+    
+   */
+  Real ss = Staff_symbol_referencer::staff_space (me);
+  Real thickness = Beam::get_thickness (me) / ss ;
+  Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
 
-  SCM sdy = me->get_grob_property ("least-squares-dy");
-  Real dy_mus = gh_number_p (sdy) ? gh_scm2double (sdy) : 0.0;
+  SCM sdy = me->get_property ("least-squares-dy");
+  Real dy_mus = is_number (sdy) ? ly_scm2double (sdy) : 0.0;
   
   Real straddle = 0.0;
   Real sit = (thickness - slt) / 2;
@@ -129,10 +143,10 @@ Beam::quanting (SCM smob)
   Array<Real> base_lengths;
   Array<Real> stem_xposns;  
 
-  Drul_array<bool> dirs_found(0,0);
+  Drul_array<bool> dirs_found (0,0);
   Grob *common[2];
   for (int a = 2; a--;)
-    common[a] = common_refpoint_of_array (stems, me, Axis(a));
+    common[a] = common_refpoint_of_array (stems, me, Axis (a));
 
   Grob * fvs = first_visible_stem (me);
   Grob *lvs = last_visible_stem (me);
@@ -147,17 +161,20 @@ Beam::quanting (SCM smob)
     stem_y != 0.0, when we're cross staff.
     
    */
-  for (int i= 0; i < stems.size(); i++)
+  for (int i= 0; i < stems.size (); i++)
     {
       Grob*s = stems[i];
-      stem_infos.push (Stem::get_stem_info (s));
+
+      Stem_info si (Stem::get_stem_info (s));
+      si.scale (1 / ss);
+      stem_infos.push (si);
       dirs_found[stem_infos.top ().dir_] = true;
 
-      bool f = to_boolean (s->get_grob_property ("french-beaming"))
+      bool f = to_boolean (s->get_property ("french-beaming"))
         && s != lvs && s != fvs;
 
       base_lengths.push (calc_stem_y (me, s, common, xl, xr,
-                                     Interval (0,0), f));
+                                     Interval (0,0), f) / ss);
       stem_xposns.push (s->relative_coordinate (common[X_AXIS], X_AXIS));
     }
 
@@ -170,14 +187,14 @@ Beam::quanting (SCM smob)
   
   Direction ldir = Direction (stem_infos[0].dir_);
   Direction rdir = Direction (stem_infos.top ().dir_);
-  bool knee_b = dirs_found[LEFT] && dirs_found[RIGHT];
+  bool is_knee = dirs_found[LEFT] && dirs_found[RIGHT];
 
 
   int region_size = REGION_SIZE;
   /*
     Knees are harder, lets try some more possibilities for knees. 
    */
-  if (knee_b)
+  if (is_knee)
     region_size += 2;
 
   /*
@@ -210,7 +227,9 @@ Beam::quanting (SCM smob)
   for (int i = qscores.size (); i--;)
     {
       Real d =  score_slopes_dy (qscores[i].yl, qscores[i].yr,
-                                dy_mus, yr- yl, xstaff);
+                                dy_mus, yr- yl, 
+                                xr - xl,
+                                xstaff);
       qscores[i].demerits += d;
 
 #if DEBUG_QUANTING
@@ -219,16 +238,22 @@ Beam::quanting (SCM smob)
     }
 
   Real rad = Staff_symbol_referencer::staff_radius (me);
-  int beam_count = get_beam_count (me);
-  Real beam_translation = get_beam_translation (me);
 
-  Real reasonable_score = (knee_b) ? 200000 : 100;
+  
+  
+  Drul_array<int> edge_beam_counts
+    (Stem::beam_multiplicity (stems[0]).length  () + 1,
+     Stem::beam_multiplicity (stems.top ()).length  () + 1);
+  
+  Real beam_translation = get_beam_translation (me) / ss;
+
+  Real reasonable_score = (is_knee) ? 200000 : 100;
   for (int i = qscores.size (); i--;)
     if (qscores[i].demerits < reasonable_score)
       {
        Real d = score_forbidden_quants (qscores[i].yl, qscores[i].yr,
                                     rad, slt, thickness, beam_translation,
-                                    beam_count, ldir, rdir); 
+                                    edge_beam_counts, ldir, rdir); 
        qscores[i].demerits += d;
 
 #if DEBUG_QUANTING
@@ -242,7 +267,7 @@ Beam::quanting (SCM smob)
        Real d=score_stem_lengths (stems, stem_infos,
                                 base_lengths, stem_xposns,
                                 xl, xr,
-                                knee_b,
+                                is_knee,
                                 qscores[i].yl, qscores[i].yr);
        qscores[i].demerits +=  d;
 
@@ -255,19 +280,18 @@ Beam::quanting (SCM smob)
 
 
 #if DEBUG_QUANTING
-  SCM inspect_quants = me->get_grob_property ("inspect-quants");
+  SCM inspect_quants = me->get_property ("inspect-quants");
   if (debug_beam_quanting_flag
-      && gh_pair_p (inspect_quants))
+      && ly_c_pair_p (inspect_quants))
     {
-      Real il = gh_scm2double (gh_car (inspect_quants));
-      Real ir = gh_scm2double (gh_cdr (inspect_quants));
+      Drul_array<Real> ins = ly_scm2interval (inspect_quants);
 
       int i = 0;
 
       Real mindist = 1e6;
-      for (; i < qscores.size(); i ++)
+      for (; i < qscores.size (); i ++)
        {
-         Real d =fabs (qscores[i].yl-il) + fabs (qscores[i].yr - ir);
+         Real d =fabs (qscores[i].yl- ins[LEFT]) + fabs (qscores[i].yr - ins[RIGHT]);
          if (d < mindist)
            {
              best_idx = i;
@@ -279,16 +303,16 @@ Beam::quanting (SCM smob)
     }
 #endif
   
-  me->set_grob_property ("positions",
-                        gh_cons (gh_double2scm (qscores[best_idx].yl),
-                                 gh_double2scm (qscores[best_idx].yr)));
+  me->set_property ("positions",
+                        ly_interval2scm (Drul_array<Real> (qscores[best_idx].yl,
+                                         qscores[best_idx].yr)));
 #if DEBUG_QUANTING
   if (debug_beam_quanting_flag)
     {
       qscores[best_idx].score_card_ += to_string ("i%d", best_idx);
       
       // debug quanting
-      me->set_grob_property ("quant-score",
+      me->set_property ("quant-score",
                             scm_makfrom0str (qscores[best_idx].score_card_.to_str0 ()));
     }
 #endif
@@ -312,7 +336,7 @@ Beam::score_stem_lengths (Link_array<Grob> const &stems,
   for (int i=0; i < stems.size (); i++)
     {
       Grob* s = stems[i];
-      if (Stem::invisible_b (s))
+      if (Stem::is_invisible (s))
        continue;
 
       Real x = stem_xs[i];
@@ -353,14 +377,23 @@ Beam::score_stem_lengths (Link_array<Grob> const &stems,
 Real
 Beam::score_slopes_dy (Real yl, Real yr,
                       Real dy_mus, Real dy_damp,
+                      Real dx,
                       bool xstaff)
 {
   Real dy = yr - yl;
-
   Real dem = 0.0;
-  if (sign (dy_damp) != sign (dy))
+
+  /*
+    DAMPING_DIRECTION_PENALTY is a very harsh measure, while for
+    complex beaming patterns, horizontal is often a good choice.
+
+    TODO: find a way to incorporate the complexity of the beam in this
+    penalty.
+   */
+  if (fabs (dy/dx) > ROUND_TO_ZERO_SLOPE
+      && sign (dy_damp) != sign (dy))
     {
-      dem += DAMPING_DIRECTIION_PENALTY;
+      dem += DAMPING_DIRECTION_PENALTY;
     }
 
    dem += MUSICAL_DIRECTION_FACTOR * (0 >? (fabs (dy) - fabs (dy_mus)));
@@ -376,6 +409,21 @@ Beam::score_slopes_dy (Real yl, Real yr,
    /* Huh, why would a too steep beam be better than a too flat one ? */
    dem += shrink_extra_weight (fabs (dy_damp) - fabs (dy), 1.5)
      * slope_penalty;
+
+#if 0
+   /*
+     almost zero slopes look like errors in horizontal beams. 
+    */
+   /*
+     This causes too much problems, because horizontal depends on
+     horizontal spacing details.  These errors should be dealt with
+     through concaveness. --hwn.
+    */
+   if (fabs (dy) > 1e-3
+       && fabs (dy / dx) < ROUND_TO_ZERO_SLOPE)
+     dem += ROUND_TO_ZERO_POINTS;
+#endif
+   
    return dem;
 }
 
@@ -396,14 +444,14 @@ Beam::score_forbidden_quants (Real yl, Real yr,
                              Real radius,
                              Real slt,
                              Real thickness, Real beam_translation,
-                             int beam_count,
+                             Drul_array<int> beam_counts,
                              Direction ldir, Direction rdir)
 {
   Real dy = yr - yl;
-  Drul_array<Real> y(yl,yr);
-  Drul_array<Direction> dirs(ldir,rdir);
+  Drul_array<Real> y (yl,yr);
+  Drul_array<Direction> dirs (ldir,rdir);
   
-  Real extra_demerit = SECONDARY_BEAM_DEMERIT / beam_count;
+  Real extra_demerit = SECONDARY_BEAM_DEMERIT / (beam_counts[LEFT] >? beam_counts[RIGHT]);
 
   /*
     Inside the staff, inter quants are forbidden.
@@ -412,15 +460,15 @@ Beam::score_forbidden_quants (Real yl, Real yr,
   Direction d = LEFT;
   do
     {
-      if (fabs (y[d]) <= (radius + 0.5) && fabs (my_modf (y[d]) - 0.5) < 1e-3)
+      if (fabs (y[d]) <= (radius + 0.5) && fabs (my_modf (y[d]) - 0.5) < BEAM_EPS)
        dem += INTER_QUANT_PENALTY;
     }
   while ((flip (&d))!= LEFT); 
 
 
-  for (int j = 1; j <= beam_count; j++)
+  do
     {
-      do
+      for (int j = 1; j <= beam_counts[d]; j++)
        {
          /*
            see if the outer staffline falls in a beam-gap
@@ -435,71 +483,51 @@ Beam::score_forbidden_quants (Real yl, Real yr,
          gap.add_point (gap1);
          gap.add_point (gap2);
 
-         if (gap.elem_b (radius))
-           dem += extra_demerit;
+         for (Real k = - radius ;
+              k <= radius + BEAM_EPS; k += 1.0) 
+           if (gap.contains (k))
+             dem += extra_demerit;
        }
-      while ((flip (&d))!= LEFT); 
     }
+  while ((flip (&d))!= LEFT); 
 
 
-  
-  // todo: use beam_count of outer stems.
-  if (beam_count >= 2)
+  if ((beam_counts[LEFT] >? beam_counts[RIGHT]) >= 2)
     {
       Real straddle = 0.0;
       Real sit = (thickness - slt) / 2;
       Real inter = 0.5;
       Real hang = 1.0 - (thickness - slt) / 2;
 
-      Real eps = 1e-3;
-
-      // hmm, without Interval/Drul_array, you get ~ 4x same code...
-      if (fabs (y[LEFT] - dirs[LEFT] * beam_translation) < radius + inter)
-       {
-         if (dirs[LEFT] == UP && dy <= eps
-             && fabs (my_modf (y[LEFT]) - sit) < eps)
-           dem += extra_demerit;
-         
-         if (dirs[LEFT] == DOWN && dy >= eps
-             && fabs (my_modf (y[LEFT]) - hang) < eps)
-           dem += extra_demerit;
-       }
 
-      if (fabs (y[RIGHT] - dirs[RIGHT] * beam_translation) < radius + inter)
-       {
-         if (dirs[RIGHT] == UP && dy >= eps
-             && fabs (my_modf (y[RIGHT]) - sit) < eps)
-           dem += extra_demerit;
-         
-         if (dirs[RIGHT] == DOWN && dy <= eps
-             && fabs (my_modf (y[RIGHT]) - hang) < eps)
-           dem += extra_demerit;
-       }
-      
-      if (beam_count >= 3)
+      Direction d = LEFT;
+      do
        {
-         if (fabs (y[LEFT] - 2 * dirs[LEFT] * beam_translation) < radius + inter)
+         if (beam_counts[d] >= 2
+             && fabs (y[d] - dirs[d] * beam_translation) < radius + inter)
            {
-             if (dirs[LEFT] == UP && dy <= eps
-                 && fabs (my_modf (y[LEFT]) - straddle) < eps)
+             if (dirs[d] == UP && dy <= BEAM_EPS
+                 && fabs (my_modf (y[d]) - sit) < BEAM_EPS)
                dem += extra_demerit;
-             
-             if (dirs[LEFT] == DOWN && dy >= eps
-                 && fabs (my_modf (y[LEFT]) - straddle) < eps)
+         
+             if (dirs[d] == DOWN && dy >= BEAM_EPS
+                 && fabs (my_modf (y[d]) - hang) < BEAM_EPS)
                dem += extra_demerit;
            }
-         
-         if (fabs (y[RIGHT] - 2 * dirs[RIGHT] * beam_translation) < radius + inter)
+
+         if (beam_counts[d] >= 3
+             && fabs (y[d] - 2 * dirs[d] * beam_translation) < radius + inter)
            {
-             if (dirs[RIGHT] == UP && dy >= eps
-                 && fabs (my_modf (y[RIGHT]) - straddle) < eps)
+             if (dirs[d] == UP && dy <= BEAM_EPS
+                 && fabs (my_modf (y[d]) - straddle) < BEAM_EPS)
                dem += extra_demerit;
              
-             if (dirs[RIGHT] == DOWN && dy <= eps
-                 && fabs (my_modf (y[RIGHT]) - straddle) < eps)
+             if (dirs[d] == DOWN && dy >= BEAM_EPS
+                 && fabs (my_modf (y[d]) - straddle) < BEAM_EPS)
                dem += extra_demerit;
            }
        }
+      while (flip (&d) != LEFT);
     }
   
   return dem;