]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
(stop_translation_timestep):
[lilypond.git] / lily / beam.cc
index dc7cd4ccedd538c955bc698169f25ae578544c84..fc93ed4bc20f40fa330a9304bad41d5fe1f75f1d 100644 (file)
@@ -3,17 +3,13 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
-  
 */
 
 /*
 TODO:
 
-
-  * Junk stem_info.
-
   * Use Number_pair i.s.o Interval to represent (yl, yr).
   
   - Determine auto knees based on positions if it's set by the user.
@@ -70,9 +66,17 @@ Beam::add_stem (Grob *me, Grob *s)
 }
 
 
-/*
-  this returns the translation between 2 adjoining beams.
- */
+Real
+Beam::get_thickness (Grob * me)
+{
+  SCM th = me->get_grob_property ("thickness");
+  if (gh_number_p (th))
+    return gh_scm2double (th)* Staff_symbol_referencer::staff_space (me);
+  else
+    return 0.0;
+}
+
+/* Return the translation between 2 adjoining beams. */
 Real
 Beam::get_beam_translation (Grob *me)
 {
@@ -81,22 +85,23 @@ Beam::get_beam_translation (Grob *me)
   return gh_scm2double (s);
 }
 
-/*
-  Maximum beam_count.
- */
+/* Maximum beam_count. */
 int
 Beam::get_beam_count (Grob *me) 
 {
   int m = 0;
   for (SCM s = me->get_grob_property ("stems"); gh_pair_p (s); s = ly_cdr (s))
     {
-      Grob *sc = unsmob_grob (ly_car (s));
-      
-      m = m >? (Stem::beam_multiplicity (sc).length () + 1);
+      Grob *stem = unsmob_grob (ly_car (s));
+      m = m >? (Stem::beam_multiplicity (stem).length () + 1);
     }
   return m;
 }
 
+
+/*
+  Space return space between beams.
+ */
 MAKE_SCHEME_CALLBACK (Beam, space_function, 2);
 SCM
 Beam::space_function (SCM smob, SCM beam_count)
@@ -105,8 +110,7 @@ Beam::space_function (SCM smob, SCM beam_count)
   
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Real line = me->get_paper ()->get_var ("linethickness");
-  Real thickness = gh_scm2double (me->get_grob_property ("thickness"))
-    * staff_space;
+  Real thickness = get_thickness (me);
   
   Real beam_translation = gh_scm2int (beam_count) < 4
     ? (2*staff_space + line - thickness) / 2.0
@@ -233,7 +237,7 @@ Beam::connect_beams (Grob *me)
       SCM this_beaming = this_stem->get_grob_property ("beaming");
 
       Direction this_dir = Directional_element_interface::get(this_stem);
-      if (i > 0)
+      if (gh_pair_p (last_beaming) && gh_pair_p (this_beaming))
        {
          int start_point = position_with_maximal_common_beams
            (last_beaming, this_beaming,
@@ -324,7 +328,7 @@ Beam::brew_molecule (SCM grob)
   Real dy = pos.delta ();
   Real dydx = dy && dx ? dy/dx : 0;
   
-  Real thick = gh_scm2double (me->get_grob_property ("thickness"));
+  Real thick = get_thickness (me);
   Real bdy = get_beam_translation (me);
 
   SCM last_beaming = SCM_EOL;;
@@ -335,6 +339,7 @@ Beam::brew_molecule (SCM grob)
   SCM gap = me->get_grob_property ("gap");
   Molecule the_beam;
   Real lt = me->get_paper ()->get_var ("linethickness");
+  
   for (int i = 0; i< stems.size(); i++)
     {
       Grob * st =stems[i];
@@ -343,6 +348,11 @@ Beam::brew_molecule (SCM grob)
       Real xposn = st->relative_coordinate (xcommon, X_AXIS);
       Real stem_width = gh_scm2double (st->get_grob_property ("thickness")) *lt;
 
+      /*
+       We do the space left of ST, with lfliebertjes pointing to the
+       right from the left stem, and rfliebertjes pointing left from
+       right stem.
+       */
       if (i > 0)
        {
          SCM left = gh_cdr (last_beaming);
@@ -408,18 +418,14 @@ Beam::brew_molecule (SCM grob)
 
          if (lfliebertjes.size() || rfliebertjes.size())
            {
-
              Real nw_f;
-             if (!Stem::first_head (st))
-               nw_f = 0;
-             else
-               {
-                 int t = Stem::duration_log (st); 
 
-                 SCM proc = me->get_grob_property ("flag-width-function");
-                 SCM result = gh_call1 (proc, scm_int2num (t));
-                 nw_f = gh_scm2double (result);
-               }
+             int t = Stem::duration_log (st); 
+
+             SCM proc = me->get_grob_property ("flag-width-function");
+             SCM result = gh_call1 (proc, scm_int2num (t));
+             nw_f = gh_scm2double (result);
+               
              
              /* Half beam should be one note-width,
                 but let's make sure two half-beams never touch */
@@ -473,7 +479,7 @@ Beam::brew_molecule (SCM grob)
 
       
       Molecule tm = Text_item::text2molecule (me, scm_makfrom0str (str.to_str0 ()), properties);
-      the_beam.add_at_edge (Y_AXIS, UP, tm, 5.0);
+      the_beam.add_at_edge (Y_AXIS, UP, tm, 5.0, 0);
     }
 #endif
     
@@ -727,7 +733,8 @@ Beam::set_stem_shorten (Grob *me)
   if (knee_b(me))
     return ;
   
-  Real forced_fraction = forced_stem_count (me) / visible_stem_count (me);
+  Real forced_fraction = 1.0 * forced_stem_count (me)
+    / visible_stem_count (me);
 
   int beam_count = get_beam_count (me);
 
@@ -775,6 +782,10 @@ Beam::after_line_breaking (SCM smob)
   return SCM_UNSPECIFIED;
 }
 
+
+/*
+  Compute  a first approximation to the beam slope.
+ */
 MAKE_SCHEME_CALLBACK (Beam, least_squares, 1);
 SCM
 Beam::least_squares (SCM smob)
@@ -802,9 +813,9 @@ Beam::least_squares (SCM smob)
   Grob *fvs  = first_visible_stem (me);
   Grob *lvs  = last_visible_stem (me);
   
-  Interval ideal (Stem::calc_stem_info (fvs).ideal_y_
+  Interval ideal (Stem::get_stem_info (fvs).ideal_y_
                  + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
-                 Stem::calc_stem_info (lvs).ideal_y_
+                 Stem::get_stem_info (lvs).ideal_y_
                  + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
   
   Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
@@ -826,23 +837,18 @@ Beam::least_squares (SCM smob)
       Interval chord (Stem::chord_start_y (first_visible_stem (me)),
                      Stem::chord_start_y (last_visible_stem (me)));
 
+      /* Simple beams (2 stems) on middle line should be allowed to be
+        slightly sloped.
+        
+        However, if both stems reach middle line,
+        ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
 
-      /*
-       TODO -- use scoring for this.
-
-       complicated, because we take stem-info.ideal for determining
-       beam slopes.
-       */
-      /* Make simple beam on middle line have small tilt */
+        For that case, we apply artificial slope */
       if (!ideal[LEFT] && chord.delta () && count == 2)
        {
-
-         /*
-           FIXME. -> UP
-         */
+         /* FIXME. -> UP */
          Direction d = (Direction) (sign (chord.delta ()) * UP);
          pos[d] = gh_scm2double (me->get_grob_property ("thickness")) / 2;
-         //                * dir;
          pos[-d] = - pos[d];
        }
       else
@@ -863,7 +869,7 @@ Beam::least_squares (SCM smob)
          if (Stem::invisible_b (s))
            continue;
          ideals.push (Offset (x_posns[i],
-                              Stem::calc_stem_info (s).ideal_y_
+                              Stem::get_stem_info (s).ideal_y_
                               + s->relative_coordinate (commony, Y_AXIS)
                               - my_y));
        }
@@ -939,7 +945,7 @@ Beam::shift_region_to_valid (SCM grob)
       Direction d = Stem::get_direction (s);
 
       Real left_y =
-       Stem::calc_stem_info (s).shortest_y_
+       Stem::get_stem_info (s).shortest_y_
        - dydx * x_posns [i];
 
       /*
@@ -1070,9 +1076,13 @@ Beam::check_concave (SCM smob)
       concave *= dir;
       concaveness2 = concave / (stems.size () - 2);
       
-      /* ugh: this is the a kludge to get
-        input/regression/beam-concave.ly to behave as
-        baerenreiter. */
+      /*
+
+      ugh: this is the a kludge to get
+      input/regression/beam-concave.ly to behave as
+      baerenreiter.
+
+      */
 
       /*
        huh? we're dividing twice (which is not scalable) meaning that
@@ -1156,10 +1166,8 @@ where_are_the_whole_beams(SCM beaming)
   return l;
 }
 
-/*
-  Calculate the Y position of the stem-end, given the Y-left, Y-right
-  in POS for stem S. This Y position is relative to S.
- */
+/* Return the Y position of the stem-end, given the Y-left, Y-right
+   in POS for stem S.  This Y position is relative to S. */
 Real
 Beam::calc_stem_y (Grob *me, Grob* s, Grob ** common,
                   Real xl, Real xr,
@@ -1219,17 +1227,13 @@ Beam::set_stem_lengths (Grob *me)
   Interval pos = ly_scm2interval (me->get_grob_property ("positions"));
   Real staff_space = Staff_symbol_referencer::staff_space (me);
 
-  bool french = to_boolean (me->get_grob_property ("french-beaming"));
-
-  
   bool gap = false;
   Real thick =0.0;
   if (gh_number_p (me->get_grob_property ("gap"))
       &&gh_scm2double (me->get_grob_property ("gap")))
   {
     gap = true;
-    thick = gh_scm2double (me->get_grob_property ("thickness"))
-      * Staff_symbol_referencer::staff_space(me);
+    thick = get_thickness(me);
   }
       
   // ugh -> use commonx
@@ -1245,6 +1249,8 @@ Beam::set_stem_lengths (Grob *me)
       if (Stem::invisible_b (s))
        continue;
 
+      
+      bool french = to_boolean (s->get_grob_property ("french-beaming"));
       Real stem_y = calc_stem_y (me, s, common,
                                 xl, xr,
                                 pos, french && i > 0&& (i < stems.size  () -1));
@@ -1280,13 +1286,18 @@ Beam::set_beaming (Grob *me, Beaming_info_list *beaming)
              ||(d == RIGHT && i == stems.size () -1))
            continue;
 
-
-         SCM beaming_prop = stems[i]->get_grob_property ("beaming");
+         Grob *st =  stems[i];
+         SCM beaming_prop = st->get_grob_property ("beaming");
          if (beaming_prop == SCM_EOL ||
              index_get_cell (beaming_prop, d) == SCM_EOL)
            {
              int b = beaming->infos_.elem (i).beams_i_drul_[d];
-             Stem::set_beaming (stems[i], b, d);
+             if (i>0
+                 && i < stems.size() -1
+                 && Stem::invisible_b (st))
+               b = b <? beaming->infos_.elem(i).beams_i_drul_[-d];
+             
+             Stem::set_beaming (st, b, d);
            }
        }
       while (flip (&d) != LEFT);
@@ -1306,7 +1317,9 @@ Beam::forced_stem_count (Grob *me)
       if (Stem::invisible_b (s))
        continue;
 
-      if (((int)Stem::chord_start_y (s)) 
+      /* I can imagine counting those boundaries as a half forced stem,
+        but let's count them full for now. */
+      if (abs (Stem::chord_start_y (s)) > 0.1
         && (Stem::get_direction (s) != Stem::get_default_dir (s)))
         f++;
     }
@@ -1387,10 +1400,6 @@ Beam::rest_collision_callback (SCM element_smob, SCM axis)
       || !Beam::visible_stem_count (beam))
     return gh_double2scm (0.0);
 
-  // make callback for rest from this.
-  // todo: make sure this calced already.
-
-  //  Interval pos = ly_scm2interval (beam->get_grob_property ("positions"));
   Interval pos (0, 0);
   SCM s = beam->get_grob_property ("positions");
   if (gh_pair_p (s) && gh_number_p (ly_car (s)))
@@ -1403,28 +1412,47 @@ Beam::rest_collision_callback (SCM element_smob, SCM axis)
   Real dydx = dy && dx ? dy/dx : 0;
   
   Direction d = Stem::get_direction (stem);
-  Real beamy = (stem->relative_coordinate (0, X_AXIS) - x0) * dydx + pos[LEFT];
+  Real stem_y = (pos[LEFT]
+                + (stem->relative_coordinate (0, X_AXIS) - x0) * dydx)
+    * d;
+  
+  Real beam_translation = get_beam_translation (beam);
+  Real beam_thickness = gh_scm2double (beam->get_grob_property ("thickness"));
+  int beam_count = get_direction_beam_count (beam, d);
+  Real height_of_my_beams = beam_thickness
+    + (beam_count - 1) * beam_translation;
+  Real beam_y = stem_y - height_of_my_beams + beam_thickness / 2.0;
 
   Real staff_space = Staff_symbol_referencer::staff_space (rest);
 
-  
-  Real rest_dim = rest->extent (rest, Y_AXIS)[d]*2.0 / staff_space; // refp??
+  /* Better calculate relative-distance directly, rather than using
+     rest_dim? */
+  Grob *common_x = rest->common_refpoint (beam, Y_AXIS);
+  Real rest_dim = rest->extent (common_x, Y_AXIS)[d] / staff_space * d;
 
-  Real minimum_dist
-    = gh_scm2double (rest->get_grob_property ("minimum-beam-collision-distance"));
-  Real dist =
-    minimum_dist +  -d  * (beamy - rest_dim) >? 0;
+  Real minimum_distance = gh_scm2double
+    (rest->get_grob_property ("minimum-beam-collision-distance"));
 
+  Real distance = beam_y - rest_dim;
+  Real shift = 0;
+  if (distance < 0)
+    shift = minimum_distance - distance;
+  else if (minimum_distance > distance)
+    shift = minimum_distance - distance;
+      
   int stafflines = Staff_symbol_referencer::line_count (rest);
 
-  // move discretely by half spaces.
-  int discrete_dist = int (ceil (dist));
+  /* Always move discretely by half spaces */
+  Real discrete_shift = ceil (shift * 2.0) / 2.0;
 
-  // move by whole spaces inside the staff.
-  if (discrete_dist < stafflines+1)
-    discrete_dist = int (ceil (discrete_dist / 2.0)* 2.0);
+  /* Inside staff, move by whole spaces*/
+  if ((rest->extent (common_x, Y_AXIS)[d] + discrete_shift) * d
+      < stafflines / 2.0
+      ||(rest->extent (common_x, Y_AXIS)[-d] + discrete_shift) * -d
+      < stafflines / 2.0)
+    discrete_shift = ceil (discrete_shift);
 
-  return gh_double2scm (-d *  discrete_dist);
+  return gh_double2scm (-d * discrete_shift);
 }
 
 bool
@@ -1474,23 +1502,22 @@ Beam::get_direction_beam_count (Grob *me, Direction d )
 
 
 ADD_INTERFACE (Beam, "beam-interface",
-  "A beam.
-
-#'thickness= weight of beams, in staffspace
-
-
-We take the least squares line through the ideal-length stems, and
-then damp that using
-
-       damped = tanh (slope)
-
-this gives an unquantized left and right position for the beam end.
-Then we take all combinations of quantings near these left and right
-positions, and give them a score (according to how close they are to
-the ideal slope, how close the result is to the ideal stems, etc.). We
-take the best scoring combination.
-
-",
-  "french-beaming position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");
+  "A beam. \n\n"
+" "
+"#'thickness= weight of beams, in staffspace "
+" "
+" "
+"We take the least squares line through the ideal-length stems, and "
+"then damp that using "
+" \n"
+"      damped = tanh (slope) \n"
+" \n"
+"this gives an unquantized left and right position for the beam end. "
+"Then we take all combinations of quantings near these left and right "
+"positions, and give them a score (according to how close they are to "
+"the ideal slope, how close the result is to the ideal stems, etc.). We "
+"take the best scoring combination. "
+,
+  "knee position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");