]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
Beam collision scoring
[lilypond.git] / lily / beam.cc
index e803b806c89fa974eddbf81769325f2dff63795b..c485813a5a797cfaf29217e619bc6015a30327eb 100644 (file)
@@ -1,10 +1,21 @@
 /*
-  beam.cc -- implement Beam
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
 
 #include "beam.hh"
 
+#include "beam-scoring-problem.hh"
 #include "beaming-pattern.hh"
 #include "directional-element-interface.hh"
-#include "main.hh"
+#include "grob-array.hh"
 #include "international.hh"
 #include "interval-set.hh"
 #include "item.hh"
 #include "least-squares.hh"
 #include "lookup.hh"
+#include "main.hh"
 #include "misc.hh"
 #include "output-def.hh"
 #include "pointer-group-interface.hh"
@@ -41,7 +54,6 @@
 #include "staff-symbol-referencer.hh"
 #include "stem.hh"
 #include "warn.hh"
-#include "grob-array.hh"
 
 #if DEBUG_BEAM_SCORING
 #include "text-interface.hh" // debug output.
@@ -62,6 +74,12 @@ Beam_stem_segment::Beam_stem_segment ()
   dir_ = CENTER;
 }
 
+bool
+beam_segment_less (Beam_segment const& a, Beam_segment const& b)
+{
+  return a.horizontal_[LEFT] < b.horizontal_[LEFT];
+}
+
 Beam_segment::Beam_segment ()
 {
   vertical_count_ = 0;
@@ -82,9 +100,9 @@ Beam::add_stem (Grob *me, Grob *s)
 }
 
 Real
-Beam::get_thickness (Grob *me)
+Beam::get_beam_thickness (Grob *me)
 {
-  return robust_scm2double (me->get_property ("thickness"), 0)
+  return robust_scm2double (me->get_property ("beam-thickness"), 0)
     * Staff_symbol_referencer::staff_space (me);
 }
 
@@ -95,12 +113,12 @@ Beam::get_beam_translation (Grob *me)
   int beam_count = get_beam_count (me);
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Real line = Staff_symbol_referencer::line_thickness (me);
-  Real thickness = get_thickness (me);
+  Real beam_thickness = get_beam_thickness (me);
   Real fract = robust_scm2double (me->get_property ("length-fraction"), 1.0);
-  
+
   Real beam_translation = beam_count < 4
-    ? (2 * staff_space + line - thickness) / 2.0
-    : (3 * staff_space + line - thickness) / 3.0;
+    ? (2 * staff_space + line - beam_thickness) / 2.0
+    : (3 * staff_space + line - beam_thickness) / 3.0;
 
   return fract * beam_translation;
 }
@@ -125,15 +143,15 @@ SCM
 Beam::calc_normal_stems (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  
+
   extract_grob_set (me, "stems", stems);
   SCM val = Grob_array::make_array ();
   Grob_array *ga = unsmob_grob_array (val);
   for (vsize i = 0; i < stems.size ();  i++)
     if (Stem::is_normal_stem (stems[i]))
       ga->add (stems[i]);
-  
-  return val;  
+
+  return val;
 }
 
 MAKE_SCHEME_CALLBACK (Beam, calc_direction, 1);
@@ -162,7 +180,7 @@ Beam::calc_direction (SCM smob)
 
          return SCM_UNSPECIFIED;
        }
-      else 
+      else
        {
          Grob *stem = first_normal_stem (me);
 
@@ -171,8 +189,8 @@ Beam::calc_direction (SCM smob)
          */
          if (!stem)
            stem = stems[0];
-         
-         if (is_direction (stem->get_property_data ("direction"))) 
+
+         if (is_direction (stem->get_property_data ("direction")))
            dir = to_dir (stem->get_property_data ("direction"));
          else
            dir = to_dir (stem->get_property ("default-direction"));
@@ -183,7 +201,7 @@ Beam::calc_direction (SCM smob)
     {
       if (!dir)
        dir = get_default_dir (me);
-      
+
       consider_auto_knees (me);
     }
 
@@ -191,7 +209,7 @@ Beam::calc_direction (SCM smob)
     {
       set_stem_directions (me, dir);
     }
-  
+
   return scm_from_int (dir);
 }
 
@@ -244,12 +262,12 @@ SCM
 Beam::calc_beaming (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  
+
   extract_grob_set (me, "stems", stems);
 
   Slice last_int;
   last_int.set_empty ();
-  
+
   SCM last_beaming = scm_cons (SCM_EOL, scm_list_1 (scm_from_int (0)));
   Direction last_dir = CENTER;
   for (vsize i = 0; i < stems.size (); i++)
@@ -288,7 +306,7 @@ Beam::calc_beaming (SCM smob)
       else
        {
          /*
-           FIXME: what's this for? 
+           FIXME: what's this for?
           */
          SCM s = scm_cdr (this_beaming);
          for (; scm_is_pair (s); s = scm_cdr (s))
@@ -298,7 +316,7 @@ Beam::calc_beaming (SCM smob)
              last_int.add_point (np);
            }
        }
-      
+
       if (scm_ilength (scm_cdr (this_beaming)) > 0)
        {
          last_beaming = this_beaming;
@@ -316,8 +334,9 @@ operator <(Beam_stem_segment const &a,
   return a.rank_ < b.rank_;
 }
 
-typedef map<int, vector<Beam_stem_segment> >  Position_stem_segments_map; 
+typedef map<int, vector<Beam_stem_segment> >  Position_stem_segments_map;
 
+// TODO - should store result in a property?
 vector<Beam_segment>
 Beam::get_beam_segments (Grob *me_grob, Grob **common)
 {
@@ -334,7 +353,7 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
   commonx = me->get_bound (RIGHT)->common_refpoint (commonx, X_AXIS);
 
   *common = commonx;
-  
+
   int gap_count = robust_scm2int (me->get_property ("gap-count"), 0);
   Real gap_length = robust_scm2double (me->get_property ("gap"), 0.0);
 
@@ -370,13 +389,13 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
              int beam_rank = scm_to_int (scm_car (s));
              ranks.add_point (beam_rank);
            }
-         
+
          for (SCM s = index_get_cell (beaming, d);
               scm_is_pair (s); s = scm_cdr (s))
            {
              if (!scm_is_integer (scm_car (s)))
                continue;
-         
+
              int beam_rank = scm_to_int (scm_car (s));
              Beam_stem_segment seg;
              seg.stem_ = stem;
@@ -386,9 +405,9 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
              seg.stem_index_ = i;
              seg.dir_ = d;
              seg.max_connect_ = robust_scm2int (stem->get_property ("max-beam-connect"), 1000);
-             
+
              Direction stem_dir = get_grob_direction (stem);
-             
+
              seg.gapped_
                = (stem_dir * beam_rank < (stem_dir * ranks[-stem_dir] + gap_count));
              stem_segments[beam_rank].push_back (seg);
@@ -439,12 +458,12 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
              bool inside_stem = (event_dir == LEFT)
                ? seg.stem_index_ > 0
                : seg.stem_index_ + 1 < stems.size () ;
-                     
+
              bool event = on_beam_bound
                || abs (seg.rank_ - neighbor_seg.rank_) > 1
                || (abs (vertical_count) >= seg.max_connect_
                    || abs (vertical_count) >= neighbor_seg.max_connect_);
-             
+
              if (!event)
                // Then this edge of the current segment is irrelevent because it will
                // be connected with the next segment in the event_dir direction.
@@ -520,7 +539,7 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
            }
          while (flip (&event_dir) != LEFT);
        }
-      
+
     }
 
   return segments;
@@ -542,7 +561,7 @@ Beam::print (SCM grob)
     }
   else
     {
-      extract_grob_set (me, "stems", stems);      
+      extract_grob_set (me, "stems", stems);
       span[LEFT] = stems[0]->relative_coordinate (commonx, X_AXIS);
       span[RIGHT] = stems.back ()->relative_coordinate (commonx, X_AXIS);
     }
@@ -564,11 +583,11 @@ Beam::print (SCM grob)
   Real dy = pos[RIGHT] - pos[LEFT];
   Real slope = (dy && span.length ()) ? dy / span.length ()  : 0;
 
-  Real thick = get_thickness (me);
+  Real beam_thickness = get_beam_thickness (me);
   Real beam_dy = get_beam_translation (me);
 
   Direction feather_dir = to_dir (me->get_property ("grow-direction"));
-  
+
   Stencil the_beam;
   for (vsize i = 0; i < segments.size (); i ++)
     {
@@ -577,18 +596,18 @@ Beam::print (SCM grob)
        {
          local_slope += feather_dir * segments[i].vertical_count_ * beam_dy / span.length ();
        }
-      
-      Stencil b = Lookup::beam (local_slope, segments[i].horizontal_.length (), thick, blot);
+
+      Stencil b = Lookup::beam (local_slope, segments[i].horizontal_.length (), beam_thickness, blot);
 
       b.translate_axis (segments[i].horizontal_[LEFT], X_AXIS);
-      
+
       b.translate_axis (local_slope
                        * (segments[i].horizontal_[LEFT] - span.linear_combination (feather_dir))
                        + pos.linear_combination (feather_dir)
                        + beam_dy * segments[i].vertical_count_, Y_AXIS);
-      the_beam.add_stencil (b);      
+      the_beam.add_stencil (b);
     }
-        
+
 #if (DEBUG_BEAM_SCORING)
   SCM annotation = me->get_property ("annotation");
   if (!scm_is_string (annotation))
@@ -597,10 +616,10 @@ Beam::print (SCM grob)
       if (to_boolean (debug))
        annotation = me->get_property ("quant-score");
     }
-  
+
   if (scm_is_string (annotation))
     {
-      extract_grob_set (me, "stems", stems);      
+      extract_grob_set (me, "stems", stems);
 
       /*
        This code prints the demerits for each beam. Perhaps this
@@ -610,10 +629,13 @@ Beam::print (SCM grob)
       string str;
       SCM properties = Font_interface::text_font_alist_chain (me);
 
+      properties = scm_cons(scm_acons (ly_symbol2scm ("font-size"), scm_from_int (-5), SCM_EOL),
+                            properties);
+      
       Direction stem_dir = stems.size () ? to_dir (stems[0]->get_property ("direction")) : UP;
 
       Stencil score = *unsmob_stencil (Text_interface::interpret_markup
-                                   (me->layout ()->self_scm (), properties, annotation));
+                                       (me->layout ()->self_scm (), properties, annotation));
 
       if (!score.is_empty ())
        {
@@ -626,7 +648,7 @@ Beam::print (SCM grob)
   the_beam.translate_axis (-me->relative_coordinate (commonx, X_AXIS), X_AXIS);
   return the_beam.smobbed_copy ();
 }
+
 Direction
 Beam::get_default_dir (Grob *me)
 {
@@ -680,7 +702,7 @@ Beam::get_default_dir (Grob *me)
       else if (extremes[UP] < -extremes[DOWN])
        return UP;
     }
-  
+
   Direction dir = CENTER;
   Direction d = CENTER;
   if ((d = (Direction) sign (count[UP] - count[DOWN])))
@@ -693,7 +715,7 @@ Beam::get_default_dir (Grob *me)
     dir = d;
   else
     dir = to_dir (me->get_property ("neutral-direction"));
-  
+
   return dir;
 }
 
@@ -794,7 +816,7 @@ Beam::consider_auto_knees (Grob *me)
     }
 
   Real beam_translation = get_beam_translation (me);
-  Real beam_thickness = Beam::get_thickness (me);
+  Real beam_thickness = Beam::get_beam_thickness (me);
   int beam_count = Beam::get_beam_count (me);
   Real height_of_beams = beam_thickness / 2
     + (beam_count - 1) * beam_translation;
@@ -842,25 +864,25 @@ set_minimum_dy (Grob *me, Real *dy)
       */
 
       Real ss = Staff_symbol_referencer::staff_space (me);
-      Real thickness = Beam::get_thickness (me) / ss;
+      Real beam_thickness = Beam::get_beam_thickness (me) / ss;
       Real slt = Staff_symbol_referencer::line_thickness (me) / ss;
-      Real sit = (thickness - slt) / 2;
+      Real sit = (beam_thickness - slt) / 2;
       Real inter = 0.5;
-      Real hang = 1.0 - (thickness - slt) / 2;
+      Real hang = 1.0 - (beam_thickness - slt) / 2;
 
       *dy = sign (*dy) * max (fabs (*dy),
                              min (min (sit, inter), hang));
     }
 }
 
-  
+
 
 MAKE_SCHEME_CALLBACK (Beam, calc_stem_shorten, 1)
 SCM
 Beam::calc_stem_shorten (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  
+
   /*
     shortening looks silly for x staff beams
   */
@@ -884,7 +906,7 @@ Beam::calc_stem_shorten (SCM smob)
 
   shorten *= forced_fraction;
 
-  
+
   if (shorten)
     return scm_from_double (shorten);
 
@@ -898,7 +920,7 @@ Beam::no_visible_stem_positions (Grob *me, Interval default_value)
   extract_grob_set (me, "stems", stems);
   if (stems.empty ())
     return default_value;
-  
+
   Interval head_positions;
   Slice multiplicity;
   for (vsize i = 0; i < stems.size(); i++)
@@ -976,7 +998,7 @@ Beam::calc_least_squares_positions (SCM smob, SCM /* posns */)
        {
          /* FIXME. -> UP */
          Direction d = (Direction) (sign (chord.delta ()) * UP);
-         pos[d] = get_thickness (me) / 2;
+         pos[d] = get_beam_thickness (me) / 2;
          pos[-d] = -pos[d];
        }
       else
@@ -1133,7 +1155,6 @@ Beam::slope_damping (SCM smob, SCM posns)
   if (normal_stem_count (me) <= 1)
     return posns;
 
-  
   SCM s = me->get_property ("damping");
   Real damping = scm_to_double (s);
   Real concaveness = robust_scm2double (me->get_property ("concaveness"), 0.0);
@@ -1143,7 +1164,7 @@ Beam::slope_damping (SCM smob, SCM posns)
       me->set_property ("least-squares-dy", scm_from_double (0));
       damping = 0;
     }
-  
+
   if (damping)
     {
       scale_drul (&pos, Staff_symbol_referencer::staff_space (me));
@@ -1175,6 +1196,21 @@ Beam::slope_damping (SCM smob, SCM posns)
   return ly_interval2scm (pos);
 }
 
+
+MAKE_SCHEME_CALLBACK (Beam, quanting, 2);
+SCM
+Beam::quanting (SCM smob, SCM posns)
+{
+  Grob *me = unsmob_grob (smob);
+  Drul_array<Real> ys(0, 0);
+  ys = robust_scm2drul (posns, ys);
+  Beam_scoring_problem problem (me, ys);
+
+  ys = problem.solve ();
+  return ly_interval2scm (ys);
+}
+
+
 /*
   Report slice containing the numbers that are both in (car BEAMING)
   and (cdr BEAMING)
@@ -1198,7 +1234,7 @@ where_are_the_whole_beams (SCM beaming)
    in POS for stem S.  This Y position is relative to S. */
 Real
 Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common,
-                  Real xl, Real xr, Direction feather_dir, 
+                  Real xl, Real xr, Direction feather_dir,
                   Drul_array<Real> pos, bool french)
 {
   Real beam_translation = get_beam_translation (me);
@@ -1222,15 +1258,15 @@ Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common,
 
   /*
     feather dir = 1 , relx 0->1 : factor 0 -> 1
-    feather dir = 0 , relx 0->1 : factor 1 -> 1    
-    feather dir = -1, relx 0->1 : factor 1 -> 0    
+    feather dir = 0 , relx 0->1 : factor 1 -> 1
+    feather dir = -1, relx 0->1 : factor 1 -> 0
    */
   Real feather_factor = 1;
   if (feather_dir > 0)
     feather_factor = relx;
   else if (feather_dir < 0)
     feather_factor = 1 - relx;
-  
+
   stem_y += feather_factor * beam_translation
     * beam_multiplicity[Direction(((french) ? DOWN : UP)*stem_dir)];
   Real id = me->relative_coordinate (common[Y_AXIS], Y_AXIS)
@@ -1243,7 +1279,7 @@ Beam::calc_stem_y (Grob *me, Grob *stem, Grob **common,
   Hmm.  At this time, beam position and slope are determined.  Maybe,
   stem directions and length should set to relative to the chord's
   position of the beam.  */
-MAKE_SCHEME_CALLBACK (Beam, set_stem_lengths, 1); 
+MAKE_SCHEME_CALLBACK (Beam, set_stem_lengths, 1);
 SCM
 Beam::set_stem_lengths (SCM smob)
 {
@@ -1254,7 +1290,7 @@ Beam::set_stem_lengths (SCM smob)
   (void) me->get_property ("beaming");
 
   SCM posns = me->get_property ("positions");
-  
+
   extract_grob_set (me, "stems", stems);
   if (!stems.size ())
     return posns;
@@ -1272,7 +1308,7 @@ Beam::set_stem_lengths (SCM smob)
   if (robust_scm2int (me->get_property ("gap-count"), 0))
     {
       gap = true;
-      thick = get_thickness (me);
+      thick = get_beam_thickness (me);
     }
 
   Grob *fvs = first_normal_stem (me);
@@ -1359,7 +1395,7 @@ Beam::forced_stem_count (Grob *me)
       /* I can imagine counting those boundaries as a half forced stem,
         but let's count them full for now. */
       Direction defdir = to_dir (s->get_property ("default-direction"));
-      
+
       if (abs (Stem::chord_start_y (s)) > 0.1
          && defdir
          && get_grob_direction (s) != defdir)
@@ -1408,7 +1444,7 @@ Beam::rest_collision_callback (SCM smob, SCM prev_offset)
     return scm_from_int (0);
 
   Real offset = robust_scm2double (prev_offset, 0.0);
-  
+
   Grob *st = unsmob_grob (rest->get_object ("stem"));
   Grob *stem = st;
   if (!stem)
@@ -1431,9 +1467,9 @@ Beam::rest_collision_callback (SCM smob, SCM prev_offset)
   Drul_array<Grob*> visible_stems (first_normal_stem (beam),
                                   last_normal_stem (beam));
   extract_grob_set (beam, "stems", stems);
-  
+
   Grob *common = common_refpoint_of_array (stems, beam, X_AXIS);
-  
+
   Real x0 = visible_stems[LEFT]->relative_coordinate (common, X_AXIS);
   Real dx = visible_stems[RIGHT]->relative_coordinate (common, X_AXIS) - x0;
   Real slope = dy && dx ? dy / dx : 0;
@@ -1443,7 +1479,7 @@ Beam::rest_collision_callback (SCM smob, SCM prev_offset)
     + (stem->relative_coordinate (common, X_AXIS) - x0) * slope;
 
   Real beam_translation = get_beam_translation (beam);
-  Real beam_thickness = Beam::get_thickness (beam);
+  Real beam_thickness = Beam::get_beam_thickness (beam);
 
   /*
     TODO: this is not strictly correct for 16th knee beams.
@@ -1457,13 +1493,9 @@ Beam::rest_collision_callback (SCM smob, SCM prev_offset)
 
   Grob *common_y = rest->common_refpoint (beam, Y_AXIS);
 
-  /*
-    TODO: this is dubious, because this call needs the info we're
-    computing right now.
-   */
-  Interval rest_extent = rest->extent (common_y, Y_AXIS);
-  rest_extent.translate (offset);
-  
+  Interval rest_extent = rest->extent (rest, Y_AXIS);
+  rest_extent.translate (offset + rest->get_parent (Y_AXIS)->relative_coordinate (common_y, Y_AXIS));
+
   Real rest_dim = rest_extent[d];
   Real minimum_distance
     = staff_space * (robust_scm2double (stem->get_property ("stemlet-length"), 0.0)
@@ -1552,7 +1584,7 @@ Beam::get_direction_beam_count (Grob *me, Direction d)
 ADD_INTERFACE (Beam,
               "A beam.\n"
               "\n"
-              "The @code{thickness} property is the weight of beams,"
+              "The @code{beam-thickness} property is the weight of beams,"
               " measured in staffspace.  The @code{direction} property is"
               " not user-serviceable.  Use the @code{direction} property"
               " of @code{Stem} instead.\n"
@@ -1590,15 +1622,17 @@ ADD_INTERFACE (Beam,
                "Damping slope which is considered zero for purposes of"
                " calculating direction penalties.\n"
                "@end table\n",
-              
+
               /* properties */
               "annotation "
               "auto-knee-gap "
               "beamed-stem-shorten "
               "beaming "
+              "beam-thickness "
               "break-overshoot "
               "clip-edges "
               "concaveness "
+              "covered-grobs "
               "damping "
               "details "
               "direction "
@@ -1616,5 +1650,4 @@ ADD_INTERFACE (Beam,
               "quantized-positions "
               "shorten "
               "stems "
-              "thickness "
               );