]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
release: 1.2.8
[lilypond.git] / lily / beam.cc
index af118cb5dddc8ee3b339b4cb628278f42ab76822..22735719719340c4a64759ffc79b7e4994a74266 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998, 1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
     Jan Nieuwenhuizen <janneke@gnu.org>
 
 */
 
 /*
   [TODO]
-    * centre beam symbol
+    * center beam symbol
     * less hairy code
     * redo grouping 
- */
+
+TODO:
+
+The relationship Stem <-> Beam is way too hairy.  Let's figure who
+needs what, and what information should be available when.
+
+    */
 
 #include <math.h>
 
-#include "p-col.hh"
-#include "array.hh"
+#include "chord-tremolo.hh"
+#include "beaming.hh"
 #include "proto.hh"
 #include "dimensions.hh"
 #include "beam.hh"
-#include "abbreviation-beam.hh"
 #include "misc.hh"
 #include "debug.hh"
-#include "atom.hh"
 #include "molecule.hh"
 #include "leastsquares.hh"
 #include "stem.hh"
 #include "paper-def.hh"
 #include "lookup.hh"
-#include "grouping.hh"
 
 Beam::Beam ()
 {
   slope_f_ = 0;
   left_y_ = 0;
-  damping_i_ = 1;
   quantisation_ = NORMAL;
   multiple_i_ = 0;
 }
@@ -46,8 +48,21 @@ Beam::Beam ()
 void
 Beam::add_stem (Stem*s)
 {
+#if 0
+  /*
+    should figure out why this didn't work.
+
+    --hwn.
+   */
+  if (!stems_.size ())
+    {
+      set_parent (s, Y_AXIS);
+    }
+#endif
   stems_.push (s);
   s->add_dependency (this);
+
+  assert (!s->beam_l_);
   s->beam_l_ = this;
 
   if (!spanned_drul_[LEFT])
@@ -56,12 +71,26 @@ Beam::add_stem (Stem*s)
     set_bounds (RIGHT,s);
 }
 
+Stem_info
+Beam::get_stem_info (Stem *s)
+{
+  Stem_info i;
+  for (int i=0; i < sinfo_.size (); i++)
+    {
+      if (sinfo_[i].stem_l_ == s)
+       return sinfo_[i];
+    }
+  assert (false);
+  return i;
+}
+
 Molecule*
 Beam::do_brew_molecule_p () const
 {
   Molecule *mol_p = new Molecule;
-  Real internote_f = paper ()->internote_f ();
-
+  if (!sinfo_.size ())
+    return mol_p;
+  
   Real x0 = stems_[0]->hpos_f ();
   for (int j=0; j <stems_.size (); j++)
     {
@@ -71,15 +100,12 @@ Beam::do_brew_molecule_p () const
 
       Molecule sb = stem_beams (i, next, prev);
       Real  x = i->hpos_f ()-x0;
-      sb.translate (Offset (x, (x * slope_f_ + left_y_) * internote_f));
+      sb.translate (Offset (x, (x * slope_f_ + left_y_) *
+                           i->staff_line_leading_f ()/2 ));
       mol_p->add_molecule (sb);
     }
   mol_p->translate_axis (x0 
-    - spanned_drul_[LEFT]->absolute_coordinate (X_AXIS), X_AXIS);
-
-  // correct if last note (and therefore reference point of beam)
-  // is on different staff
-  mol_p->translate_axis (- sinfo_.top ().interstaff_f_ * internote_f, Y_AXIS);
+    - spanned_drul_[LEFT]->relative_coordinate (0, X_AXIS), X_AXIS);
 
   return mol_p;
 }
@@ -87,15 +113,21 @@ Beam::do_brew_molecule_p () const
 Offset
 Beam::center () const
 {
-  Real w= (paper ()->note_width () + extent (X_AXIS).length ())/2.0;
-  return Offset (w, (left_y_ + w* slope_f_)*paper ()->internote_f ());
+  Stem_info si = sinfo_[0];
+  
+  Real w= (si.stem_l_->note_delta_f () + extent (X_AXIS).length ())/2.0;
+  return Offset (w, ( w* slope_f_) *
+                si.stem_l_->staff_line_leading_f ()/2);
 }
 
 void
 Beam::do_pre_processing ()
 {
   if (!dir_)
-    set_default_dir ();
+    dir_ = get_default_dir ();
+  
+  
+  set_direction (dir_);
 }
 
 void
@@ -113,7 +145,7 @@ Beam::do_post_processing ()
   if (stems_.size () < 2)
     {
       warning (_ ("beam with less than two stems"));
-      transparent_b_ = true;
+      set_elt_property (transparent_scm_sym, SCM_BOOL_T);
       return ;
     }
   calculate_slope ();
@@ -121,7 +153,7 @@ Beam::do_post_processing ()
 }
 
 void
-Beam::do_substitute_dependent (Score_element*o,Score_element*n)
+Beam::do_substitute_element_pointer (Score_element*o,Score_element*n)
 {
   if (Stem * os = dynamic_cast<Stem*> (o))
     stems_.substitute (os,
@@ -135,15 +167,15 @@ Beam::do_width () const
                   stems_.top ()->hpos_f ());
 }
 
-void
-Beam::set_default_dir ()
+Direction
+Beam::get_default_dir () const
 {
   Drul_array<int> total;
   total[UP]  = total[DOWN] = 0;
   Drul_array<int> count; 
   count[UP]  = count[DOWN] = 0;
   Direction d = DOWN;
-  
+
   for (int i=0; i <stems_.size (); i++)
     do {
       Stem *s = stems_[i];
@@ -167,36 +199,56 @@ Beam::set_default_dir ()
      wants to provide some real simple hands-on rules.
      
      We have our doubts, so we simply provide all sensible alternatives.
+
+     If dir is not determined: up (see stem::get_default_dir ())
   */
 
-  Dir_algorithm a = (Dir_algorithm)rint(paper ()->get_var ("beam_dir_algorithm"));
+  Direction beam_dir;
+  Direction neutral_dir = (Direction)(int)paper_l ()->get_var ("stem_default_neutral_direction");
+
+  Dir_algorithm a = (Dir_algorithm)rint(paper_l ()->get_var ("beam_dir_algorithm"));
   switch (a)
     {
     case MAJORITY:
-      dir_ = (count[UP] > count[DOWN]) ? UP : DOWN;
+      beam_dir = (count[UP] == count[DOWN]) ? neutral_dir 
+        : (count[UP] > count[DOWN]) ? UP : DOWN;
       break;
     case MEAN:
-      // mean centre distance
-      dir_ = (total[UP] > total[DOWN]) ? UP : DOWN;
+      // mean center distance
+      beam_dir = (total[UP] == total[DOWN]) ? neutral_dir
+        : (total[UP] > total[DOWN]) ? UP : DOWN;
       break;
     default:
     case MEDIAN:
-      // median centre distance
-      if (!count[UP])
-       dir_ = DOWN;
-      else if (!count[DOWN])
-       dir_ = UP;
+      // median center distance
+      if (!count[DOWN] || !count[UP])
+        {
+         beam_dir = (count[UP] == count[DOWN]) ? neutral_dir 
+           : (count[UP] > count[DOWN]) ? UP : DOWN;
+       }
       else
-       dir_ = (total[UP] / count[UP] > total[DOWN] / count[DOWN]) ? UP : DOWN;
+        {
+         beam_dir = (total[UP] / count[UP] == total[DOWN] / count[DOWN]) 
+           ? neutral_dir 
+             : (total[UP] / count[UP] > total[DOWN] / count[DOWN]) ? UP : DOWN;
+       }
       break;
     }
+  return beam_dir;
+}
 
+void
+Beam::set_direction (Direction d)
+{
+  dir_ = d;
   for (int i=0; i <stems_.size (); i++)
     {
       Stem *s = stems_[i];
-      s->beam_dir_ = dir_;
-      if (!s->dir_forced_b_)
-       s->dir_ = dir_;
+      s->set_elt_property (beam_dir_scm_sym, gh_int2scm (d));
+
+      SCM force = s->remove_elt_property (dir_forced_scm_sym);
+      if (force == SCM_BOOL_F)
+       s->dir_ = d;
     }
 }
 
@@ -207,9 +259,6 @@ Beam::set_default_dir ()
 void
 Beam::solve_slope ()
 {
-  /*
-    should use minimum energy formulation (cf linespacing)
-  */
   assert (sinfo_.size () > 1);
   DOUT << "Beam::solve_slope: \n";
 
@@ -221,13 +270,17 @@ Beam::solve_slope ()
   l.minimise (slope_f_, left_y_);
 }
 
+/*
+  ugh. Naming: this doesn't check, but sets as well.
+ */
+  
 Real
 Beam::check_stemlengths_f (bool set_b)
 {
-  Real interbeam_f = paper ()->interbeam_f (multiple_i_);
-  Real internote_f = paper ()->internote_f (); 
-  Real beam_f = paper ()->beam_thickness_f ();
-  Real staffline_f = paper ()->rule_thickness ();
+  Real interbeam_f = paper_l ()->interbeam_f (multiple_i_);
+
+  Real beam_f = paper_l ()->beam_thickness_f ();
+  Real staffline_f = paper_l ()->rule_thickness ();
   Real epsilon_f = staffline_f / 8;
   Real dy_f = 0.0;
   for (int i=0; i < sinfo_.size (); i++)
@@ -237,10 +290,11 @@ Beam::check_stemlengths_f (bool set_b)
       // correct for knee
       if (dir_ != sinfo_[i].dir_)
        {
+         Real internote_f = sinfo_[i].stem_l_->staff_line_leading_f ()/2;
          y -= dir_ * (beam_f / 2
                       + (sinfo_[i].mult_i_ - 1) * interbeam_f) / internote_f;
-         if (!i && sinfo_[i].stem_l_->staff_sym_l_ !=
-             sinfo_.top ().stem_l_->staff_sym_l_)
+         if (!i && sinfo_[i].stem_l_->staff_symbol_l () !=
+             sinfo_.top ().stem_l_->staff_symbol_l ())
            y += dir_ * (multiple_i_ - (sinfo_[i].stem_l_->flag_i_ - 2) >? 0)
              * interbeam_f / internote_f;
        }
@@ -255,8 +309,8 @@ Beam::check_stemlengths_f (bool set_b)
        { 
          // when all too short, normal stems win..
          if (dy_f < -epsilon_f)
-           warning (_ ("weird beam shift, check your knees"));
-         dy_f = dy_f >? sinfo_[i].miny_f_ - y;
+           warning (_ ("weird beam vertical offset"));
+         dy_f = dy_f >? sinfo_[i].miny_f_ - y; 
        }
     }
   return dy_f;
@@ -265,13 +319,16 @@ Beam::check_stemlengths_f (bool set_b)
 void
 Beam::set_steminfo ()
 {
+  if(!stems_.size ())
+    return;
+  
   assert (multiple_i_);
   int total_count_i = 0;
   int forced_count_i = 0;
   for (int i=0; i < stems_.size (); i++)
     {
       Stem *s = stems_[i];
-      s->mult_i_ = multiple_i_;
+
       s->set_default_extents ();
       if (s->invisible_b ())
        continue;
@@ -280,20 +337,26 @@ Beam::set_steminfo ()
       total_count_i++;
     }
 
-  Real internote_f = paper ()->internote_f ();
-  int stem_max = (int)rint(paper ()->get_var ("stem_max"));
-  Real shorten_f = paper ()->get_var (String ("forced_stem_shorten"
-                                             + to_str (multiple_i_ <? stem_max)))
-    / internote_f;
+  bool grace_b = get_elt_property (grace_scm_sym) != SCM_BOOL_F;
+  String type_str = grace_b ? "grace_" : "";
+  int stem_max = (int)rint(paper_l ()->get_var ("stem_max"));
+  Real shorten_f = paper_l ()->get_var (type_str + "forced_stem_shorten"
+                                       + to_str (multiple_i_ <? stem_max));
     
   Real leftx = 0;
   for (int i=0; i < stems_.size (); i++)
     {
       Stem *s = stems_[i];
-      if (s->invisible_b ())
-       continue;
+      /*
+       Chord tremolo needs to beam over invisible stems of wholes
+      */
+      if (!dynamic_cast<Chord_tremolo*> (this))
+       {
+         if (s->invisible_b ())
+           continue;
+       }
 
-      Stem_info info (s);
+      Stem_info info (s, multiple_i_);
       if (leftx == 0)
        leftx = info.x_;
       info.x_ -= leftx;
@@ -331,9 +394,10 @@ Beam::calculate_slope ()
       Real dx_f = stems_.top ()->hpos_f () - stems_[0]->hpos_f ();
 
       // urg, these y internote-y-dimensions
-      Real internote_f = paper ()->internote_f ();
-      Real lengthened = paper ()->get_var ("beam_lengthened") / internote_f;
-      Real steep = paper ()->get_var ("beam_steep_slope") / internote_f;
+      Real internote_f = stems_[0]->staff_line_leading_f ()/2;
+
+      Real lengthened = paper_l ()->get_var ("beam_lengthened") / internote_f;
+      Real steep = paper_l ()->get_var ("beam_steep_slope") / internote_f;
       if (((left_y_ - sinfo_[0].idealy_f_ > lengthened)
           && (slope_f_ > steep))
          || ((left_y_ + slope_f_ * dx_f - sinfo_.top ().idealy_f_ > lengthened)
@@ -347,8 +411,13 @@ Beam::calculate_slope ()
        damped = tanh (slope_f_)
        corresponds with some tables in [Wanske]
       */
-      if (damping_i_)
-       slope_f_ = 0.6 * tanh (slope_f_) / damping_i_;
+      SCM damp = remove_elt_property (damping_scm_sym);
+      int damping = 1;         // ugh.
+      if (damp!= SCM_BOOL_F)
+       damping = gh_int2scm (SCM_CDR(damp));
+
+      if (damping)
+       slope_f_ = 0.6 * tanh (slope_f_) / damping;
       
       quantise_dy ();
 
@@ -375,10 +444,10 @@ Beam::quantise_dy ()
   if (quantisation_ <= NONE)
     return;
 
-  Real interline_f = paper ()->interline_f ();
+  Real interline_f = stems_[0]->staff_line_leading_f ();
   Real internote_f = interline_f / 2;
-  Real staffline_f = paper ()->rule_thickness ();
-  Real beam_f = paper ()->beam_thickness_f ();
+  Real staffline_f = paper_l ()->rule_thickness ();
+  Real beam_f = paper_l ()->beam_thickness_f ();
 
   Real dx_f = stems_.top ()->hpos_f () - stems_[0]->hpos_f ();
 
@@ -395,9 +464,9 @@ Beam::quantise_dy ()
 
 
   Interval iv = quantise_iv (allowed_fraction, interline_f, dy_f);
-  quanty_f = (dy_f - iv.min () <= iv.max () - dy_f)
-    ? iv.min ()
-    : iv.max ();
+  quanty_f = (dy_f - iv[SMALLER] <= iv[BIGGER] - dy_f)
+    ? iv[SMALLER]
+    : iv[BIGGER];
 
 
   slope_f_ = (quanty_f / dx_f) / internote_f * sign (slope_f_);
@@ -433,10 +502,10 @@ Beam::quantise_left_y (bool extend_b)
        hang       straddle   sit        inter      hang
    */
 
-  Real interline_f = paper ()->interline_f ();
-  Real internote_f = paper ()->internote_f ();
-  Real staffline_f = paper ()->rule_thickness ();
-  Real beam_f = paper ()->beam_thickness_f ();
+  Real space = stems_[0]->staff_line_leading_f ();
+  Real internote_f = space /2;
+  Real staffline_f = paper_l ()->rule_thickness ();
+  Real beam_f = paper_l ()->beam_thickness_f ();
 
   /*
     [TODO]
@@ -446,8 +515,8 @@ Beam::quantise_left_y (bool extend_b)
 
   Real straddle = 0;
   Real sit = beam_f / 2 - staffline_f / 2;
-  Real inter = interline_f / 2;
-  Real hang = interline_f - beam_f / 2 + staffline_f / 2;
+  Real inter = space / 2;
+  Real hang = space - beam_f / 2 + staffline_f / 2;
 
   /*
     Put all allowed positions into an array.
@@ -510,11 +579,11 @@ Beam::quantise_left_y (bool extend_b)
        }
     }
 
-  Interval iv = quantise_iv (allowed_position, interline_f, dy_f);
+  Interval iv = quantise_iv (allowed_position, space, dy_f);
 
-  Real quanty_f = dy_f - iv.min () <= iv.max () - dy_f ? iv.min () : iv.max ();
+  Real quanty_f = dy_f - iv[SMALLER] <= iv[BIGGER] - dy_f ? iv[SMALLER] : iv[BIGGER];
   if (extend_b)
-    quanty_f = iv.max ();
+    quanty_f = iv[BIGGER];
 
   // dim(left_y_) = internote
   left_y_ = dir_ * quanty_f / internote_f;
@@ -523,11 +592,12 @@ Beam::quantise_left_y (bool extend_b)
 void
 Beam::set_stemlens ()
 {
-  Real staffline_f = paper ()->rule_thickness ();
+  Real staffline_f = paper_l ()->rule_thickness ();
   // enge floots
   Real epsilon_f = staffline_f / 8;
 
-  DOUT << "Beam::set_stemlens: \n";
+
+  // je bent zelf eng --hwn.
   Real dy_f = check_stemlengths_f (false);
   for (int i = 0; i < 2; i++)
     { 
@@ -536,7 +606,6 @@ Beam::set_stemlens ()
       dy_f = check_stemlengths_f (true);
       if (abs (dy_f) <= epsilon_f)
         {
-         DOUT << "Beam::set_stemlens: " << i << " iterations\n";
          break;
        }
     }
@@ -545,65 +614,57 @@ Beam::set_stemlens ()
   test_pos %= 4;
 }
 
-/*
- FIXME
- ugh.  this is broken and should be rewritten.
-  - [c8. c32 c32]
- */
 void
-Beam::set_grouping (Rhythmic_grouping def, Rhythmic_grouping cur)
+Beam::set_beaming (Beaming_info_list *beaming)
+{
+  Direction d = LEFT;
+  for (int i=0; i  < stems_.size (); i++)
+    {
+      do
+       {
+         if (stems_[i]->beams_i_drul_[d] < 0)
+           stems_[i]->beams_i_drul_[d] = beaming->infos_.elem (i).beams_i_drul_[d];
+       }
+      while (flip (&d) != LEFT);
+    }
+}
+
+
+void
+Beam::do_add_processing ()
 {
-  def.OK ();
-  cur.OK ();
-  assert (cur.children.size () == stems_.size ());
-
-  cur.split (def);
-
-  Array<int> b;
-  {
-    Array<int> flags;
-    for (int j=0; j <stems_.size (); j++)
-      {
-       Stem *s = stems_[j];
-
-       int f = s->flag_i_ - 2;
-       assert (f>0);
-       flags.push (f);
-      }
-    int fi =0;
-    b= cur.generate_beams (flags, fi);
-    b.insert (0,0);
-    b.push (0);
-    assert (stems_.size () == b.size ()/2);
-  }
-
-  for (int j=0, i=0; i < b.size () && j <stems_.size (); j++)
+  for (int i=0; i < stems_.size () ; i++) 
     {
-      Stem *s = stems_[j];
       Direction d = LEFT;
       do {
-       if (s->beams_i_drul_[d] < 0)
-         s->beams_i_drul_[d] = b[i];
-
-       multiple_i_ = multiple_i_ >? s->beams_i_drul_[d];
-       i++;
+       multiple_i_ = multiple_i_ >? stems_[i]->beams_i_drul_[d];
       } while ((flip (&d)) != LEFT);
     }
+
+  if (stems_.size ())
+    {
+      stems_[0]->beams_i_drul_[LEFT] =0;
+      stems_.top()->beams_i_drul_[RIGHT] =0;
+    }
 }
 
+
+
 /*
   beams to go with one stem.
   */
 Molecule
 Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
 {
-  assert (!next || next->hpos_f () > here->hpos_f ());
-  assert (!prev || prev->hpos_f () < here->hpos_f ());
+  if ((next && !(next->hpos_f () > here->hpos_f ())) ||
+      (prev && !(prev->hpos_f () < here->hpos_f ())))
+      programming_error ("Beams are not left-to-right");
+
+  Real staffline_f = paper_l ()->rule_thickness ();
+  Real interbeam_f = paper_l ()->interbeam_f (multiple_i_);
 
-  Real staffline_f = paper ()->rule_thickness ();
-  Real interbeam_f = paper ()->interbeam_f (multiple_i_);
-  Real internote_f = paper ()->internote_f (); 
-  Real beam_f = paper ()->beam_thickness_f ();
+  Real internote_f = here->staff_line_leading_f ()/2;
+  Real beam_f = paper_l ()->beam_thickness_f ();
 
   Real dy = interbeam_f;
   Real stemdx = staffline_f;
@@ -614,7 +675,15 @@ Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
   Molecule rightbeams;
 
   // UGH
-  Real nw_f = paper ()->note_width () * 0.8;
+  Real nw_f;
+  if (!here->head_l_arr_.size ())
+    nw_f = 0;
+  else if (here->type_i ()== 1)
+    nw_f = paper_l ()->get_var ("wholewidth");
+  else if (here->type_i () == 2)
+    nw_f = paper_l ()->note_width () * 0.8;
+  else
+    nw_f = paper_l ()->get_var ("quartwidth");
 
   /* half beams extending to the left. */
   if (prev)
@@ -627,15 +696,15 @@ Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
        */
       Real w = here->hpos_f () - prev->hpos_f ();
       w = w/2 <? nw_f;
-      Atom a;
+      Molecule a;
       if (lhalfs)              // generates warnings if not
        a =  lookup_l ()->beam (sl, w, beam_f);
       a.translate (Offset (-w, -w * sl));
       for (int j = 0; j  < lhalfs; j++)
        {
-         Atom b (a);
+         Molecule b (a);
          b.translate_axis (-dir_ * dy * (lwholebeams+j), Y_AXIS);
-         leftbeams.add_atom (b);
+         leftbeams.add_molecule (b);
        }
     }
 
@@ -645,18 +714,22 @@ Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
       int rwholebeams = here->beams_i_drul_[RIGHT] <? next->beams_i_drul_[LEFT];
 
       Real w = next->hpos_f () - here->hpos_f ();
-      Atom a = lookup_l ()->beam (sl, w + stemdx, beam_f);
+      Molecule a = lookup_l ()->beam (sl, w + stemdx, beam_f);
       a.translate_axis( - stemdx/2, X_AXIS);
       int j = 0;
       Real gap_f = 0;
-      if (here->beam_gap_i_)
+
+      SCM gap = get_elt_property (beam_gap_scm_sym);
+      if (gap != SCM_BOOL_F)
        {
-         int nogap = rwholebeams - here->beam_gap_i_;
+         int gap_i = gh_scm2int (SCM_CDR (gap));
+         int nogap = rwholebeams - gap_i;
+         
          for (; j  < nogap; j++)
            {
-             Atom b (a);
+             Molecule b (a);
              b.translate_axis (-dir_ * dy * j, Y_AXIS);
-             rightbeams.add_atom (b);
+             rightbeams.add_molecule (b);
            }
          // TODO: notehead widths differ for different types
          gap_f = nw_f / 2;
@@ -666,9 +739,12 @@ Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
 
       for (; j  < rwholebeams; j++)
        {
-         Atom b (a);
-         b.translate (Offset (gap_f, -dir_ * dy * j));
-         rightbeams.add_atom (b);
+         Molecule b (a);
+         if (!here->invisible_b ())
+           b.translate (Offset (gap_f, -dir_ * dy * j));
+         else
+           b.translate (Offset (0, -dir_ * dy * j));
+         rightbeams.add_molecule (b);
        }
 
       w = w/2 <? nw_f;
@@ -677,9 +753,9 @@ Beam::stem_beams (Stem *here, Stem *next, Stem *prev) const
 
       for (; j  < rwholebeams + rhalfs; j++)
        {
-         Atom b (a);
+         Molecule b (a);
          b.translate_axis (-dir_ * dy * j, Y_AXIS);
-         rightbeams.add_atom (b);
+         rightbeams.add_molecule (b);
        }
 
     }