]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
* lily/beam.cc (set_minimum_dy): new function. Round non-zero
[lilypond.git] / lily / beam.cc
index 0ef6741faccea779d1cebb0e95bd8345d2aeb7c6..9b71b10331057076c8945abe4af90c3979bfb1bc 100644 (file)
@@ -35,7 +35,7 @@ Notes:
 #include "misc.hh"
 #include "least-squares.hh"
 #include "stem.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "lookup.hh"
 #include "group-interface.hh"
 #include "staff-symbol-referencer.hh"
@@ -43,8 +43,6 @@ Notes:
 #include "spanner.hh"
 #include "warn.hh"
 
-bool debug_beam_quanting_flag;
-
 
 #if DEBUG_QUANTING
 #include "text-item.hh"  // debug output.
@@ -82,7 +80,7 @@ Beam::get_beam_translation (Grob *me)
   if (ly_c_procedure_p (func))
     {
       SCM s = scm_call_2 (func, me->self_scm (), scm_int2num (get_beam_count (me)));
-      return ly_scm2double (s);
+      return scm_to_double (s);
     }
   else
     {
@@ -117,7 +115,7 @@ Beam::space_function (SCM smob, SCM beam_count)
   Real line = Staff_symbol_referencer::line_thickness (me);
   Real thickness = get_thickness (me);
   
-  Real beam_translation = ly_scm2int (beam_count) < 4
+  Real beam_translation = scm_to_int (beam_count) < 4
     ? (2*staff_space + line - thickness) / 2.0
     : (3*staff_space + line - thickness) / 3.0;
   
@@ -211,7 +209,7 @@ position_with_maximal_common_beams (SCM left_beaming, SCM right_beaming,
       int count =0;
       for ( SCM s = ly_car (right_beaming); ly_c_pair_p (s); s = ly_cdr (s))
        {
-         int k = - right_dir * ly_scm2int (ly_car (s)) + i;
+         int k = - right_dir * scm_to_int (ly_car (s)) + i;
          if (scm_c_memq (scm_int2num (k), left_beaming) != SCM_BOOL_F)
            count ++;
        }
@@ -260,7 +258,7 @@ Beam::connect_beams (Grob *me)
              for (; ly_c_pair_p (s); s = ly_cdr (s))
                {
                  int new_beam_pos =
-                   start_point - this_dir * ly_scm2int (ly_car (s));
+                   start_point - this_dir * scm_to_int (ly_car (s));
 
                  new_slice.add_point (new_beam_pos);
                  scm_set_car_x (s, scm_int2num (new_beam_pos));
@@ -279,7 +277,7 @@ Beam::connect_beams (Grob *me)
          SCM s = ly_cdr (this_beaming);
          for (; ly_c_pair_p (s); s = ly_cdr (s))
            {
-             int np = - this_dir * ly_scm2int (ly_car (s));
+             int np = - this_dir * scm_to_int (ly_car (s));
              scm_set_car_x (s, scm_int2num (np));
              last_int.add_point (np);
            }
@@ -339,10 +337,10 @@ Beam::print (SCM grob)
   else
     pos= ly_scm2realdrul (posns);
 
-  scale_drul (  &pos,  Staff_symbol_referencer::staff_space (me));
+  scale_drul (&pos,  Staff_symbol_referencer::staff_space (me));
   
   Real dy = pos[RIGHT] - pos[LEFT];
-  Real dydx = (dy && dx) ? dy/dx : 0;
+  Real slope = (dy && dx) ? dy/dx : 0;
   
   Real thick = get_thickness (me);
   Real bdy = get_beam_translation (me);
@@ -351,7 +349,7 @@ Beam::print (SCM grob)
   Real last_xposn = -1;
   Real last_stem_width = -1 ;
 
-  Real gap_length =robust_scm2double ( me->get_property ("gap"), 0.0);
+  Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
   
   Stencil the_beam;
   Real lt = me->get_paper ()->get_dimension (ly_symbol2scm ("linethickness"));
@@ -369,7 +367,7 @@ Beam::print (SCM grob)
        right from the left stem, and rfliebertjes pointing left from
        right stem.
        */
-      SCM left = (i>0) ? ly_cdr (last_beaming) : SCM_EOL;
+      SCM left = (i > 0) ? ly_cdr (last_beaming) : SCM_EOL;
       SCM right = st ? ly_car (this_beaming) : SCM_EOL;
 
       Array<int> full_beams;
@@ -379,7 +377,7 @@ Beam::print (SCM grob)
       for (SCM s = left;
           ly_c_pair_p (s); s =ly_cdr (s))
        {
-         int b = ly_scm2int (ly_car (s));
+         int b = scm_to_int (ly_car (s));
          if (scm_c_memq (ly_car (s), right) != SCM_BOOL_F)
            {
              full_beams.push (b);
@@ -392,7 +390,7 @@ Beam::print (SCM grob)
       for (SCM s = right;
           ly_c_pair_p (s); s =ly_cdr (s))
        {
-         int b = ly_scm2int (ly_car (s));
+         int b = scm_to_int (ly_car (s));
          if (scm_c_memq (ly_car (s), left) == SCM_BOOL_F)
            {
              rfliebertjes.push (b);
@@ -417,14 +415,14 @@ Beam::print (SCM grob)
       
 
       Real blot = me->get_paper ()->get_dimension (ly_symbol2scm ("blotdiameter"));
-      Stencil whole = Lookup::beam (dydx, w, thick, blot);
+      Stencil whole = Lookup::beam (slope, w, thick, blot);
       Stencil gapped;
 
       int gap_count = 0;
-      if (ly_c_number_p (me->get_property ("gap-count")))
+      if (scm_is_number (me->get_property ("gap-count")))
        {
-         gap_count = ly_scm2int (me->get_property ("gap-count"));
-         gapped = Lookup::beam (dydx, w - 2 * gap_length, thick, blot);
+         gap_count = scm_to_int (me->get_property ("gap-count"));
+         gapped = Lookup::beam (slope, w - 2 * gap_length, thick, blot);
 
          full_beams.sort (default_compare);
          if (stem_dir == UP)
@@ -442,7 +440,7 @@ Beam::print (SCM grob)
              b.translate_axis (gap_length, X_AXIS);
            }
          b.translate_axis (last_xposn -  x0 + stem_offset, X_AXIS);
-         b.translate_axis (dydx * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
+         b.translate_axis (slope * (last_xposn - x0) + bdy * full_beams[j], Y_AXIS);
 
          the_beam.add_stencil (b);           
        }
@@ -457,7 +455,7 @@ Beam::print (SCM grob)
 
              SCM proc = me->get_property ("flag-width-function");
              SCM result = scm_call_1 (proc, scm_int2num (t));
-             nw_f = ly_scm2double (result);
+             nw_f = scm_to_double (result);
            }
          else
            nw_f = break_overshoot / 2;
@@ -481,20 +479,20 @@ Beam::print (SCM grob)
            lw = me->get_bound (RIGHT)->relative_coordinate (xcommon, X_AXIS)
              - last_xposn;
 
-         Stencil rhalf = Lookup::beam (dydx, rw, thick, blot);
-         Stencil lhalf = Lookup::beam (dydx, lw, thick, blot);
+         Stencil rhalf = Lookup::beam (slope, rw, thick, blot);
+         Stencil lhalf = Lookup::beam (slope, lw, thick, blot);
          for (int j = lfliebertjes.size (); j--;)
            {
              Stencil b (lhalf);
              b.translate_axis (last_xposn -  x0, X_AXIS);
-             b.translate_axis (dydx * (last_xposn-x0) + bdy * lfliebertjes[j], Y_AXIS);
+             b.translate_axis (slope * (last_xposn-x0) + bdy * lfliebertjes[j], Y_AXIS);
              the_beam.add_stencil (b);       
            }
          for (int j = rfliebertjes.size (); j--;)
            {
              Stencil b (rhalf);
              b.translate_axis (xposn -  x0 - rw , X_AXIS);
-             b.translate_axis (dydx * (xposn-x0 -rw) + bdy * rfliebertjes[j], Y_AXIS);
+             b.translate_axis (slope * (xposn-x0 -rw) + bdy * rfliebertjes[j], Y_AXIS);
              the_beam.add_stencil (b);       
            }
        }
@@ -510,8 +508,8 @@ Beam::print (SCM grob)
 
 #if (DEBUG_QUANTING)
   SCM quant_score = me->get_property ("quant-score");
-  if (debug_beam_quanting_flag
-      && ly_c_string_p (quant_score))
+  if (to_boolean (me->get_paper ()->lookup_variable (ly_symbol2scm ("debug-beam-quanting")))
+      && scm_is_string (quant_score))
     {
       
       /*
@@ -522,13 +520,13 @@ Beam::print (SCM grob)
       String str;
       SCM properties = Font_interface::text_font_alist_chain (me);
 
+      Direction stem_dir = stems.size() ? to_dir (stems[0]->get_property ("direction")) : UP;
+    
       Stencil tm = *unsmob_stencil (Text_item::interpret_markup
         (me->get_paper ()->self_scm (), properties, quant_score));
-      the_beam.add_at_edge (Y_AXIS, UP, tm, 5.0, 0);
+      the_beam.add_at_edge (Y_AXIS, stem_dir, tm, 1.0, 0);
     }
 #endif
-    
-  
   
   return the_beam.smobbed_copy ();
 }
@@ -548,7 +546,7 @@ Beam::get_default_dir (Grob *me)
   Link_array<Grob> stems=
        Pointer_group_interface__extract_grobs (me, (Grob*)0, "stems");
 
-  for (int i=0; i <stems.size (); i++)
+  for (int i=0; i < stems.size (); i++)
     do {
       Grob *s = stems[i];
       Direction sd = get_grob_direction (s);
@@ -570,7 +568,7 @@ Beam::get_default_dir (Grob *me)
                    scm_cons (scm_int2num (total[UP]),
                             scm_int2num (total[DOWN])));
 
-  if (ly_c_number_p (s) && ly_scm2int (s))
+  if (scm_is_number (s) && scm_to_int (s))
     return to_dir (s);
   
   /* If dir is not determined: get default */
@@ -666,10 +664,10 @@ void
 Beam::consider_auto_knees (Grob* me)
 {
   SCM scm = me->get_property ("auto-knee-gap");
-  if (!ly_c_number_p (scm))
+  if (!scm_is_number (scm))
     return ;
 
-  Real threshold = ly_scm2double (scm);
+  Real threshold = scm_to_double (scm);
   
   Int_set gaps;
 
@@ -791,7 +789,7 @@ Beam::set_stem_shorten (Grob *me)
   
   SCM shorten_elt =
     robust_list_ref (beam_count -1, shorten_list);
-  Real shorten_f = ly_scm2double (shorten_elt) * staff_space;
+  Real shorten_f = scm_to_double (shorten_elt) * staff_space;
 
   /* your similar cute comment here */
   shorten_f *= forced_fraction;
@@ -838,6 +836,29 @@ Beam::position_beam (Grob *me)
 }
 
 
+void
+set_minimum_dy (Grob *me, Real * dy)
+{
+  if (*dy)
+    {
+      /*
+       If dy is smaller than the smallest quant, we
+       get absurd direction-sign penalties. 
+      */
+         
+      Real ss = Staff_symbol_referencer::staff_space (me);
+      Real thickness = Beam::get_thickness (me) / ss ;
+      Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
+      Real sit = (thickness - slt) / 2;
+      Real inter = 0.5;
+      Real hang = 1.0 - (thickness - slt) / 2;
+         
+      *dy = sign (*dy) * (fabs (*dy)
+                       >?
+                       (sit <? inter <? hang));
+    }
+}
+
 /*
   Compute  a first approximation to the beam slope.
  */
@@ -885,7 +906,7 @@ Beam::least_squares (SCM smob)
 
   
   Real y =0;  
-  Real dydx = 0;
+  Real slope = 0;
   Real dy = 0;
   
   if (!ideal.delta ())
@@ -914,11 +935,11 @@ Beam::least_squares (SCM smob)
 
       /*
        For broken beams this doesn't work well. In this case, the
-        slope esp. of the first part of a broken beam should predict
-        where the second part goes.
-       */
+       slope esp. of the first part of a broken beam should predict
+       where the second part goes.
+      */
       me->set_property ("least-squares-dy",
-                            scm_make_real (pos[RIGHT] - pos[LEFT]));
+                       scm_make_real (pos[RIGHT] - pos[LEFT]));
     }
   else
     {
@@ -934,9 +955,11 @@ Beam::least_squares (SCM smob)
                               - my_y));
        }
       
-      minimise_least_squares (&dydx, &y, ideals);
+      minimise_least_squares (&slope, &y, ideals);
+
+      dy = slope * dx;
 
-      dy = dydx * dx;
+      set_minimum_dy (me,&dy);
       me->set_property ("least-squares-dy", scm_make_real (dy));
       pos = Interval (y, (y+dy));
     }
@@ -956,10 +979,10 @@ Beam::least_squares (SCM smob)
   We can't combine with previous function, since check concave and
   slope damping comes first.
 
-TODO: we should use the concaveness to control the amount of damping
-applied.
+  TODO: we should use the concaveness to control the amount of damping
+  applied.
   
- */
+*/
 MAKE_SCHEME_CALLBACK (Beam, shift_region_to_valid, 1);
 SCM
 Beam::shift_region_to_valid (SCM grob)
@@ -1000,7 +1023,7 @@ Beam::shift_region_to_valid (SCM grob)
   
   Real dy = pos[RIGHT] - pos[LEFT];
   Real y = pos[LEFT];
-  Real dydx =dy/dx;
+  Real slope =dy/dx;
 
   
   /*
@@ -1019,7 +1042,7 @@ Beam::shift_region_to_valid (SCM grob)
 
       Real left_y =
        Stem::get_stem_info (s).shortest_y_
-       - dydx * x_posns [i];
+       - slope * x_posns [i];
 
       /*
        left_y is now relative to the stem S. We want relative to
@@ -1055,121 +1078,6 @@ Beam::shift_region_to_valid (SCM grob)
   return SCM_UNSPECIFIED;
 }
 
-MAKE_SCHEME_CALLBACK (Beam, check_concave, 1);
-SCM
-Beam::check_concave (SCM smob)
-{
-  Grob *me = unsmob_grob (smob);
-
-  Link_array<Grob> stems = 
-    Pointer_group_interface__extract_grobs (me, (Grob*) 0, "stems");
-
-  Direction beam_dir = CENTER;
-  for (int i = 0; i < stems.size ();)
-    {
-      if (Stem::is_invisible (stems[i]))
-       stems.del (i);
-      else
-       {
-         if (Direction sd = Stem::get_direction (stems[i]))
-           {
-             /*
-               Don't do knee beams.
-              */
-             if (beam_dir && sd && sd != beam_dir)
-               return SCM_UNSPECIFIED;
-             
-             beam_dir = sd;
-           }
-         i++;
-       }
-    }
-  
-  if (stems.size () < 3)
-    return SCM_UNSPECIFIED;
-
-
-  /* Concaveness #1: If distance of an inner notehead to line between
-     two outer noteheads is bigger than CONCAVENESS-GAP (2.0ss),
-     beam is concave (Heinz Stolba).
-
-     In the case of knees, the line connecting outer heads is often
-     not related to the beam slope (it may even go in the other
-     direction). Skip the check when the outer stems point in
-     different directions. --hwn
-     
-  */
-  bool is_concave1 = false;
-  SCM gap = me->get_property ("concaveness-gap");
-  if (ly_c_number_p (gap))
-    {
-      Real r1 = ly_scm2double (gap);
-      Real dy = Stem::chord_start_y (stems.top ())
-       - Stem::chord_start_y (stems[0]);
-
-      
-      Real slope = dy / (stems.size () - 1);
-      
-      Real y0 = Stem::chord_start_y (stems[0]);
-      for (int i = 1; i < stems.size () - 1; i++)
-       {
-         Real c =
-           beam_dir *((Stem::chord_start_y (stems[i]) - y0) - i * slope);
-         if (c - r1 > 0)
-           {
-             is_concave1 = true;
-             break;
-           }
-       }
-    }
-
-    
-  /* Concaveness #2: Sum distances of inner noteheads that fall
-     outside the interval of the two outer noteheads.
-
-     We only do this for beams where first and last stem have the same
-     direction. --hwn.
-
-
-     Note that "convex" stems compensate for "concave" stems.
-     (is that intentional?) --hwn.
-  */
-  
-  Real concaveness2 = 0;
-  SCM thresh = me->get_property ("concaveness-threshold");
-  Real r2 = infinity_f;
-  if (!is_concave1 && ly_c_number_p (thresh))
-    {
-      r2 = ly_scm2double (thresh);
-      
-      Interval iv;
-      iv.add_point (Stem::chord_start_y (stems[0]));
-      iv.add_point (Stem::chord_start_y (stems.top ()));
-      
-      for (int i = 1; i < stems.size () - 1; i++)
-       {
-         Real f = Stem::chord_start_y (stems[i]);
-         concaveness2 += ( (f - iv[MAX] ) >? 0) +
-           ( (f - iv[MIN] ) <? 0);
-       }
-      
-      concaveness2 *= beam_dir / (stems.size () - 2);
-    }
-  
-  /* TODO: some sort of damping iso -> plain horizontal */
-  if (is_concave1 || concaveness2 > r2)
-    {
-      Drul_array<Real> pos = ly_scm2interval (me->get_property ("positions"));
-      Real r = linear_combination (pos, 0);
-
-      r /= Staff_symbol_referencer::staff_space (me);
-      me->set_property ("positions", ly_interval2scm (Drul_array<Real> (r, r)));
-      me->set_property ("least-squares-dy", scm_make_real (0));
-    }
-
-  return SCM_UNSPECIFIED;
-}
-
 /* This neat trick is by Werner Lemberg,
    damped = tanh (slope)
    corresponds with some tables in [Wanske] CHECKME */
@@ -1183,11 +1091,11 @@ Beam::slope_damping (SCM smob)
     return SCM_UNSPECIFIED;
 
   SCM s = me->get_property ("damping"); 
-  int damping = ly_scm2int (s);
+  Real damping = scm_to_double (s);
 
   if (damping)
     {
-      Drul_array<Real>  pos = ly_scm2interval (me->get_property ("positions"));
+      Drul_array<Real> pos = ly_scm2interval (me->get_property ("positions"));
       scale_drul (&pos,  Staff_symbol_referencer::staff_space (me));
       
       Real dy = pos[RIGHT] - pos[LEFT];
@@ -1200,10 +1108,17 @@ Beam::slope_damping (SCM smob)
 
       Real dx = last_visible_stem (me)->relative_coordinate (commonx, X_AXIS)
        - first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
-      Real dydx = dy && dx ? dy/dx : 0;
-      dydx = 0.6 * tanh (dydx) / damping;
 
-      Real damped_dy = dydx * dx;
+      Real slope = dy && dx ? dy/dx : 0;
+
+      Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
+      
+      slope = 0.6 * tanh (slope) / (damping + concaveness);
+
+      Real damped_dy = slope * dx;
+
+      set_minimum_dy (me, &damped_dy);
+      
       pos[LEFT] += (dy - damped_dy) / 2;
       pos[RIGHT] -= (dy - damped_dy) / 2;
 
@@ -1227,7 +1142,7 @@ where_are_the_whole_beams (SCM beaming)
     {
       if (scm_c_memq (ly_car (s), ly_cdr (beaming)) != SCM_BOOL_F)
        
-       l.add_point (ly_scm2int (ly_car (s)));
+       l.add_point (scm_to_int (ly_car (s)));
     }
 
   return l;
@@ -1297,8 +1212,8 @@ Beam::set_stem_lengths (Grob *me)
 
   bool gap = false;
   Real thick =0.0;
-  if (ly_c_number_p (me->get_property ("gap-count"))
-      &&ly_scm2int (me->get_property ("gap-count")))
+  if (scm_is_number (me->get_property ("gap-count"))
+      &&scm_to_int (me->get_property ("gap-count")))
     {
       gap = true;
       thick = get_thickness (me);
@@ -1453,9 +1368,9 @@ SCM
 Beam::rest_collision_callback (SCM element_smob, SCM axis)
 {
   Grob *rest = unsmob_grob (element_smob);
-  Axis a = (Axis) ly_scm2int (axis);
+  Axis a = (Axis) scm_to_int (axis);
 
-  if (ly_c_number_p (rest->get_property ("staff-position")))
+  if (scm_is_number (rest->get_property ("staff-position")))
     return scm_int2num (0);
   
   assert (a == Y_AXIS);
@@ -1472,7 +1387,7 @@ Beam::rest_collision_callback (SCM element_smob, SCM axis)
 
   Drul_array<Real> pos (0, 0);
   SCM s = beam->get_property ("positions");
-  if (ly_c_pair_p (s) && ly_c_number_p (ly_car (s)))
+  if (ly_c_pair_p (s) && scm_is_number (ly_car (s)))
     pos = ly_scm2interval (s);
   Real staff_space = Staff_symbol_referencer::staff_space (rest);
 
@@ -1484,10 +1399,10 @@ Beam::rest_collision_callback (SCM element_smob, SCM axis)
   // ugh -> use commonx
   Real x0 = first_visible_stem (beam)->relative_coordinate (0, X_AXIS);
   Real dx = last_visible_stem (beam)->relative_coordinate (0, X_AXIS) - x0;
-  Real dydx = dy && dx ? dy/dx : 0;
+  Real slope = dy && dx ? dy/dx : 0;
   
   Direction d = Stem::get_direction (stem);
-  Real stem_y = pos[LEFT] + (stem->relative_coordinate (0, X_AXIS) - x0) * dydx;
+  Real stem_y = pos[LEFT] + (stem->relative_coordinate (0, X_AXIS) - x0) * slope;
   
   Real beam_translation = get_beam_translation (beam);
   Real beam_thickness = Beam::get_thickness (beam);
@@ -1525,7 +1440,7 @@ bool
 Beam::is_knee (Grob* me)
 {
   SCM k = me->get_property ("knee");
-  if (ly_c_boolean_p (k))
+  if (scm_is_bool (k))
     return ly_scm2bool (k);
 
   bool knee = false;
@@ -1571,10 +1486,10 @@ ADD_INTERFACE (Beam, "beam-interface",
               "The @code{thickness} property is the weight of beams, and is measured "
               "in  staffspace"
               ,
-              "knee positioning-done position-callbacks concaveness-gap "
-              "concaveness-threshold dir-function quant-score auto-knee-gap gap "
+              "knee positioning-done position-callbacks "
+              "concaveness dir-function quant-score auto-knee-gap gap "
               "gap-count chord-tremolo beamed-stem-shorten shorten least-squares-dy "
-              "damping flag-width-function neutral-direction positions space-function "
+              "damping inspect-quants flag-width-function neutral-direction positions space-function "
               "thickness");