]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
Merge commit 'origin' into beamlets2
[lilypond.git] / lily / beam.cc
index f7cd01f4c95daf261e19925f2730003365784ac7..46ed26ba6604bab63e8c939708d53d1b87ee5ad0 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
   Jan Nieuwenhuizen <janneke@gnu.org>
 */
 
@@ -167,9 +167,15 @@ Beam::calc_direction (SCM smob)
          Grob *stem = first_normal_stem (me);
 
          /*
-           ugh: stems[0] case happens for chord tremolo.
+           This happens for chord tremolos.
          */
-         dir = to_dir ((stem ? stem : stems[0])->get_property ("default-direction"));
+         if (!stem)
+           stem = stems[0];
+         
+         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"));
        }
     }
 
@@ -335,6 +341,12 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
   Position_stem_segments_map stem_segments;
   Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
 
+  /* There are two concepts of "rank" that are used in the following code.
+     The beam_rank is the vertical position of the beam (larger numbers are
+     closer to the noteheads). Beam_stem_segment.rank_, on the other hand,
+     is the horizontal position of the segment (this is incremented by two
+     for each stem; the beam segment on the right side of the stem has
+     a higher rank (by one) than its neighbour to the left). */
   Slice ranks;
   for (vsize i = 0; i < stems.size (); i++)
     {
@@ -345,6 +357,10 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
       Direction d = LEFT;
       do
        {
+         // Find the maximum and minimum beam ranks.
+         // Given that RANKS is never reset to empty, the interval will always be
+         // smallest for the left beamlet of the first stem, and then it might grow.
+         // Do we really want this? (It only affects the tremolo gaps) --jneem
          for (SCM s = index_get_cell (beaming, d);
               scm_is_pair (s); s = scm_cdr (s))
            {
@@ -394,34 +410,51 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
 
       Beam_segment current;
 
+      // Iterate over all of the segments of the current beam rank,
+      // merging the adjacent Beam_stem_segments into one Beam_segment
+      // when appropriate.
       int vertical_count =  (*i).first;
       for (vsize j = 0; j < segs.size (); j++)
        {
-         /*
-           event_dir == LEFT: left edge of a beamsegment.
-          */
+         // Keeping track of the different directions here is a little tricky.
+         // segs[j].dir_ is the direction of the beam segment relative to the stem
+         // (ie. segs[j].dir_ == LEFT if the beam segment sticks out to the left of
+         // its stem) whereas event_dir refers to the edge of the beam segment that
+         // we are currently looking at (ie. if segs[j].dir_ == event_dir then we
+         // are looking at that edge of the beam segment that is furthest from its
+         // stem).
          Direction event_dir = LEFT;
+         Beam_stem_segment const& seg = segs[j];
          do
            {
-             bool on_line_bound = (segs[j].dir_ == LEFT) ? segs[j].stem_index_ == 0
-               : segs[j].stem_index_ == stems.size() - 1;
+             Beam_stem_segment const& neighbor_seg = segs[j + event_dir];
+             // TODO: make names clearer? --jneem
+             // on_line_bound: whether the current segment is on the boundary of the WHOLE beam
+             // on_beam_bound: whether the current segment is on the boundary of just that part
+             //   of the beam with the current beam_rank
+             bool on_line_bound = (seg.dir_ == LEFT) ? seg.stem_index_ == 0
+               : seg.stem_index_ == stems.size() - 1;
              bool on_beam_bound = (event_dir == LEFT) ? j == 0 :
                j == segs.size () - 1;
              bool inside_stem = (event_dir == LEFT)
-               ? segs[j].stem_index_ > 0
-               : segs[j].stem_index_ + 1 < stems.size () ;
+               ? seg.stem_index_ > 0
+               : seg.stem_index_ + 1 < stems.size () ;
                      
              bool event = on_beam_bound
-               || abs (segs[j].rank_ - segs[j+event_dir].rank_) > 1
-               || (abs (vertical_count) >= segs[j].max_connect_
-                   || abs (vertical_count) >= segs[j + event_dir].max_connect_);
+               || 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.
                continue;
 
              current.vertical_count_ = vertical_count;
-             current.horizontal_[event_dir] = segs[j].stem_x_;
-             if (segs[j].dir_ == event_dir)
+             current.horizontal_[event_dir] = seg.stem_x_;
+             if (seg.dir_ == event_dir)
+               // then we are examining the edge of a beam segment that is furthest
+               // from its stem.
                {
                  if (on_line_bound
                      && me->get_bound (event_dir)->break_status_dir ())
@@ -433,38 +466,40 @@ Beam::get_beam_segments (Grob *me_grob, Grob **common)
                    }
                  else
                    {
-                     Real notehead_width = 
-                       Stem::duration_log (segs[j].stem_) == 1
-                       ? 1.98
-                       : 1.32; // URG.
-
+                     Grob *stem = stems[seg.stem_index_];
+                     Drul_array<Real> beamlet_length =
+                       robust_scm2interval (stem->get_property ("beamlet-default-length"), Interval (1.0, 1.0));
+                     Drul_array<Real> max_proportion =
+                       robust_scm2interval (stem->get_property ("beamlet-max-length-proportion"), Interval (0.5, 0.5));
+                     Real length = beamlet_length[seg.dir_];
 
                      if (inside_stem)
                        {
-                         Grob *neighbor_stem = stems[segs[j].stem_index_ + event_dir];
-                         Real neighbor_stem_x
-                           = neighbor_stem->relative_coordinate (commonx, X_AXIS);
+                         Grob *neighbor_stem = stems[seg.stem_index_ + event_dir];
+                         Real neighbor_stem_x = neighbor_stem->relative_coordinate (commonx, X_AXIS);
 
-                         notehead_width = min (notehead_width,
-                                               fabs (neighbor_stem_x - segs[j].stem_x_)/2.5);
+                         length = min (length,
+                                       fabs (neighbor_stem_x - seg.stem_x_) * max_proportion[seg.dir_]);
                        }
-                     current.horizontal_[event_dir] += event_dir * notehead_width;
+                     current.horizontal_[event_dir] += event_dir * length;
                    }
                }
              else
+               // we are examining the edge of a beam segment that is closest
+               // (ie. touching, unless there is a gap) its stem.
                {
-                 current.horizontal_[event_dir] += event_dir * segs[j].width_/2;
-                 if (segs[j].gapped_)
+                 current.horizontal_[event_dir] += event_dir * seg.width_/2;
+                 if (seg.gapped_)
                    {
                      current.horizontal_[event_dir] -= event_dir * gap_length;
 
-                     if (Stem::is_invisible (segs[j].stem_))
+                     if (Stem::is_invisible (seg.stem_))
                        {
                          /*
                            Need to do this in case of whole notes. We don't want the
                            heads to collide with the beams.
                           */
-                         extract_grob_set (segs[j].stem_, "note-heads", heads);
+                         extract_grob_set (seg.stem_, "note-heads", heads);
 
                          for (vsize k = 0; k < heads.size (); k ++)
                            current.horizontal_[event_dir]
@@ -555,9 +590,15 @@ Beam::print (SCM grob)
     }
         
 #if (DEBUG_BEAM_SCORING)
-  SCM quant_score = me->get_property ("quant-score");
-  SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-scoring"));
-  if (to_boolean (debug) && scm_is_string (quant_score))
+  SCM annotation = me->get_property ("annotation");
+  if (!scm_is_string (annotation))
+    {
+      SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-beam-scoring"));
+      if (to_boolean (debug))
+       annotation = me->get_property ("quant-score");
+    }
+  
+  if (scm_is_string (annotation))
     {
       extract_grob_set (me, "stems", stems);      
 
@@ -572,10 +613,13 @@ Beam::print (SCM grob)
       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, quant_score));
+                                   (me->layout ()->self_scm (), properties, annotation));
 
       if (!score.is_empty ())
-       the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0);
+       {
+         score.translate_axis (me->relative_coordinate(commonx, X_AXIS), X_AXIS);
+         the_beam.add_at_edge (Y_AXIS, stem_dir, score, 1.0);
+       }
     }
 #endif
 
@@ -848,22 +892,44 @@ Beam::calc_stem_shorten (SCM smob)
 }
 
 
+Interval
+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++)
+    {
+      head_positions.unite (Stem::head_positions (stems[i]));
+      multiplicity.unite (Stem::beam_multiplicity (stems[i]));
+    }
+
+  Direction dir = get_grob_direction (me);
+  Real y = head_positions[dir]
+    * 0.5 * Staff_symbol_referencer::staff_space (me)
+    + dir * get_beam_translation (me) * (multiplicity.length () + 1);
+
+  y /= Staff_symbol_referencer::staff_space (me);
+  return Interval (y,y);
+}
+
 
 /*
   Compute a first approximation to the beam slope.
 */
 MAKE_SCHEME_CALLBACK (Beam, calc_least_squares_positions, 2);
 SCM
-Beam::calc_least_squares_positions (SCM smob, SCM posns)
+Beam::calc_least_squares_positions (SCM smob, SCM /* posns */)
 {
-  (void) posns;
-  
   Grob *me = unsmob_grob (smob);
 
   int count = normal_stem_count (me);
   Interval pos (0,0);
   if (count < 1)
-    return ly_interval2scm (pos);
+    return ly_interval2scm (no_visible_stem_positions (me, pos));
 
   vector<Real> x_posns;
   extract_grob_set (me, "normal-stems", stems);
@@ -1230,7 +1296,7 @@ Beam::set_stem_lengths (SCM smob)
        for normal beams, but for tremolo beams it looks silly otherwise.
       */
       if (gap
-          && !Stem::is_invisible (s))
+         && !Stem::is_invisible (s))
        stem_y += thick * 0.5 * get_grob_direction (s);
 
       /*
@@ -1484,16 +1550,15 @@ 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, "
-              "measured in staffspace.  The @code{direction} "
-              "property is not user-serviceable. Use "
-              "the @code{direction} property of @code{Stem} instead. "
-
-              ,
+              "A beam.\n"
+              "\n"
+              "The @code{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.",
               
               /* properties */
+              "annotation "
               "auto-knee-gap "
               "beamed-stem-shorten "
               "beaming "
@@ -1502,7 +1567,7 @@ ADD_INTERFACE (Beam,
               "concaveness "
               "damping "
               "details "
-              "direction " 
+              "direction "
               "gap "
               "gap-count "
               "grow-direction "