]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/auto-beam-engraver.cc
release: 1.1.56
[lilypond.git] / lily / auto-beam-engraver.cc
index 78e084822798da43e4c3eb564e29aba05db532ac..77094004d368cc2bb6b450dd0eb620b541afb910 100644 (file)
   (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
-
+#include "new-beaming.hh"
 #include "auto-beam-engraver.hh"
 #include "musical-request.hh"
 #include "bar.hh"
 #include "beam.hh"
-#include "grouping.hh"
 #include "rest.hh"
 #include "stem.hh"
 #include "debug.hh"
-#include "time-description.hh"
+#include "timing-engraver.hh"
+#include "engraver-group-engraver.hh"
 
 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
 
 Auto_beam_engraver::Auto_beam_engraver ()
 {
-  beam_p_ = 0;
+  stem_l_arr_p_ = 0;
+  shortest_mom_ = Moment (1, 8);
   finished_beam_p_ = 0;
   finished_grouping_p_ = 0;
   grouping_p_ = 0;
+  timer_l_ =0;
 }
 
-/*
-  should move this to rational, but may reject now
-  */
-Rational
-str2rat (String str)
+void
+Auto_beam_engraver::do_creation_processing ()
+{
+  Translator * t = daddy_grav_l  ()->get_simple_translator ("Timing_engraver");
+  timer_l_ = dynamic_cast<Timing_engraver*> (t);
+}
+
+bool
+Auto_beam_engraver::do_try_music (Music* m) 
 {
-  int num;
-  int den = 1;
-  if (int i = str.index_i ('/') != -1)
+  /*
+    Mag dit?  Nu word-i toch maar geswallowed, en
+    komt er dus ook geen announce...
+   */
+  if (Skip_req* s = dynamic_cast <Skip_req*> (m))
     {
-      den = str.cut_str (i + 1, str.length_i ()).value_i ();
-      str = str.left_str (i);
+      if (stem_l_arr_p_)
+       end_beam ();
+      return true;
     }
-  num = str.value_i ();
-  return Rational (num, den);
-}
+  return false;
+} 
 
 void
 Auto_beam_engraver::do_process_requests ()
 {
-  Time_description const *time = get_staff_info().time_C_;
+  consider_end_and_begin (shortest_mom_);
+}
+
+void
+Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
+{
+  if (!timer_l_)
+      return;
+  
+  Time_description const *time = &timer_l_->time_;
+  int num = time->whole_per_measure_ / time->one_beat_;
+  int den = time->one_beat_.den_i ();
+  String time_str = String ("time") + to_str (num) + "_" + to_str (den);
+
+  String type_str;
+  if (test_mom.num () != 1)
+    type_str = to_str (test_mom.num ());
+  if (test_mom.den () != 1)
+    type_str = type_str + "_" + to_str (test_mom.den ());
+
+  /*
+    Determine end moment for auto beaming (and begin, mostly 0==anywhere) 
+    In order of increasing priority:
+
+    i.   every beat <den>
+    ii.  time<num>_<den>beamAutoEnd
+    iii. time<num>_<den>beamAutoEnd<type>
+    iv.  beamAutoEnd
+    v.   beamAutoEnd<type>
+
+
+    Rationale:
+
+    [to be defined in config file]
+    i.   easy catch-all rule
+    ii.  exceptions for time signature
+    iii. exceptions for time signature, for specific duration type
+
+    [user override]
+    iv.  generic override
+    v.   override for specific duration type
+
+    The user overrides should be required for common cases.
+   */
+  
+  /*
+    first guess: begin beam at any position
+  */
+  Moment begin_mom (0);
+  /*
+    first guess: end beam at end of beat
+  */
+  Moment end_mom = time->one_beat_;
+
+  /*
+    second guess: property generic time exception
+  */
+  Scalar begin = get_property (time_str + "beamAutoBegin", 0);
+  if (begin.length_i ())
+    begin_mom = begin.to_rat ();
+
+  Scalar end = get_property (time_str + "beamAutoEnd", 0);
+  if (end.length_i ())
+    end_mom = end.to_rat ();
+
+  /*
+    third guess: property time exception, specific for duration type
+  */
+  if (type_str.length_i ())
+    {
+      Scalar end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0);
+      if (end_mult.length_i ())
+       end_mom = end_mult.to_rat ();
+      Scalar begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0);
+      if (begin_mult.length_i ())
+       begin_mom = begin_mult.to_rat ();
+    }
 
-  Scalar begin = get_property ("beamAutoBegin", 0);
-  Moment begin_mom = str2rat (begin);
+  /*
+    fourth guess [user override]: property plain generic
+  */
+  begin = get_property ("beamAutoBegin", 0);
+  if (begin.length_i ())
+    begin_mom = begin.to_rat ();
   
-  Scalar end = get_property ("beamAutoEnd", 0);
-  Moment end_mom = str2rat (end);
+  end = get_property ("beamAutoEnd", 0);
+  if (end.length_i ())
+    end_mom = end.to_rat ();
 
-  if (mult_i_)
+  /*
+    fifth guess [user override]: property plain, specific for duration type
+  */
+  if (type_str.length_i ())
     {
-      Scalar end_mult = get_property (String ("beamAutoEnd")
-                                     + to_str (1 << (mult_i_ + 2)), 0);
+      Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
       if (end_mult.length_i ())
-       end_mom = str2rat (end_mult);
-      else if (end_mom / Moment (mult_i_, 1) > Moment (4))
-       end_mom /= Moment (mult_i_);
+       end_mom = end_mult.to_rat ();
+      Scalar begin_mult = get_property (String ("beamAutoBegin") + type_str, 0);
+      if (begin_mult.length_i ())
+       begin_mom = begin_mult.to_rat ();
     }
 
-  Real f;
+  Rational r;
   if (end_mom)
-    f = fmod (time->whole_in_measure_, end_mom);
+    r = time->whole_in_measure_.mod_rat (end_mom);
   else
-    f = Moment (1);
+    r = Moment (1);
 
-  // enge floots
-  Real epsilon_f = Moment (1, 512);
-  if (beam_p_ && (abs (f) < epsilon_f))
+  if (stem_l_arr_p_ && !r)
     end_beam ();
      
   /*
@@ -84,8 +174,8 @@ Auto_beam_engraver::do_process_requests ()
     return;
 
   if (begin_mom)
-    f = fmod (time->whole_in_measure_, begin_mom);
-  if (!beam_p_ && (!begin_mom || (abs (f) < epsilon_f)))
+    r = time->whole_in_measure_.mod_rat (begin_mom);
+  if (!stem_l_arr_p_ && (!begin_mom || !r))
     begin_beam ();
 }
 
@@ -93,48 +183,50 @@ Auto_beam_engraver::do_process_requests ()
 void
 Auto_beam_engraver::begin_beam ()
 {
-  DOUT << String ("starting autobeam at: ") + now_moment ().str () + "\n";
-  beam_p_ = new Beam;
-  grouping_p_ = new Rhythmic_grouping;
+  assert (!stem_l_arr_p_);
+  stem_l_arr_p_ = new Array<Stem*>;
+  assert (!grouping_p_);
+  grouping_p_ = new Beaming_info_list;
+  beam_start_moment_ = now_mom ();
+  beam_start_location_ = timer_l_->time_.whole_in_measure_;
+}
+
+Beam*
+Auto_beam_engraver::create_beam_p ()
+{
+  Beam* beam_p = new Beam;
+
+  for (int i = 0; i < stem_l_arr_p_->size (); i++)
+    beam_p->add_stem ((*stem_l_arr_p_)[i]);
 
-      /* urg, copied from Beam_engraver */
+  /* urg, copied from Beam_engraver */
   Scalar prop = get_property ("beamslopedamping", 0);
   if (prop.isnum_b ()) 
-    beam_p_->damping_i_ = prop;
+    beam_p->set_elt_property (damping_scm_sym, gh_int2scm( prop));
 
   prop = get_property ("beamquantisation", 0);
   if (prop.isnum_b ()) 
-    beam_p_->quantisation_ = (Beam::Quantisation)(int)prop;
+    beam_p->quantisation_ = (Beam::Quantisation)(int)prop;
  
-      // must set minVerticalAlign = = maxVerticalAlign to get sane results
-      // see input/test/beam-interstaff.ly
-  prop = get_property ("minVerticalAlign", 0);
-  if (prop.isnum_b ())
-    beam_p_->vertical_align_drul_[MIN] = prop;
-
-  prop = get_property ("maxVerticalAlign", 0);
-  if (prop.isnum_b ())
-    beam_p_->vertical_align_drul_[MAX] = prop;
-
-  announce_element (Score_element_info (beam_p_, 0));
+  announce_element (Score_element_info (beam_p, 0));
+  return beam_p;
 }
 
 void
 Auto_beam_engraver::end_beam ()
 {
-  DOUT << String ("ending autobeam at: ") + now_moment ().str () + "\n";
-  if (beam_p_->stems_.size () < 2)
+  if (stem_l_arr_p_->size () < 2)
     {
-      DOUT << "junking autombeam: less than two stems\n";
       junk_beam ();
     }
   else
     {
-      finished_beam_p_ = beam_p_;
+      finished_beam_p_ = create_beam_p ();
       finished_grouping_p_ = grouping_p_;
-      beam_p_ = 0;
+      delete stem_l_arr_p_;
+      stem_l_arr_p_ = 0;
       grouping_p_ = 0;
-      mult_i_ = 0;
+      shortest_mom_ = Moment (1, 8);
     }
 }
  
@@ -143,9 +235,8 @@ Auto_beam_engraver::typeset_beam ()
 {
   if (finished_beam_p_)
     {
-      Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
-      rg_C->extend (finished_grouping_p_->interval());
-      finished_beam_p_->set_grouping (*rg_C, *finished_grouping_p_);
+      finished_grouping_p_->beamify ();
+      finished_beam_p_->set_beaming (finished_grouping_p_);
       typeset_element (finished_beam_p_);
       finished_beam_p_ = 0;
     
@@ -168,85 +259,90 @@ Auto_beam_engraver::do_pre_move_processing ()
 void
 Auto_beam_engraver::do_removal_processing ()
 {
+  if (stem_l_arr_p_)
+    end_beam ();
   typeset_beam ();
-  if (beam_p_)
-    {
-      DOUT << "Unfinished beam\n";
-      junk_beam ();
-    }
+}
+
+bool
+Auto_beam_engraver::same_grace_state_b (Score_element* e)
+{
+  bool gr = (e->get_elt_property (grace_scm_sym) != SCM_BOOL_F) ;
+
+  return gr == get_property ("weAreGraceContext",0).to_bool ();
 }
 
 void
 Auto_beam_engraver::acknowledge_element (Score_element_info info)
 {
-  if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
+  if (!same_grace_state_b (info.elem_l_) || !timer_l_)
+    return;
+  
+  if (stem_l_arr_p_)
     {
-      if (beam_p_)
+      if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
        {
-         DOUT << "junking autobeam: beam encountered\n";
          junk_beam ();
        }
-    }
-  if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
-    {
-      if (beam_p_)
+      else if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
        {
-         DOUT << "junking autobeam: bar encountered\n";
          junk_beam ();
        }
-    }
-
-  if (beam_p_)
-    {
-      Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
-      if (!rhythmic_req)
-       return;
-
-      if (dynamic_cast<Rest *> (info.elem_l_))
+      else if (Rest* rest_l = dynamic_cast<Rest *> (info.elem_l_))
        {
-         DOUT << "junking autobeam: rest encountered\n";
          end_beam ();
-         return;
        }
-
-      Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_);
-      if (!stem_l)
-       return;
-
-      if (stem_l->beam_l_ && (stem_l->beam_l_ != beam_p_))
+      else if (Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_))
        {
-         DOUT << "junking autobeam: beamed stem encountered\n";
-         junk_beam ();
-         return;
-       }
-       
+         Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
+         if (!rhythmic_req)
+           {
+             programming_error ("Stem must have rhythmic structure");
+             return;
+           }
+         
+         if (stem_l->beam_l_)
+           {
+             junk_beam ();
+             return ;
+           }
+             
+             /*
+               now that we have last_add_mom_, perhaps we can (should) do away
+               with these individual junk_beams
+             */
 
-      /*
-       now that we have last_add_mom_, perhaps we can (should) do away
-       with these individual junk_beams
-       */
-      if (rhythmic_req->duration_.durlog_i_<= 2)
-       {
-         DOUT << "ending autobeam: stem doesn't fit in beam\n";
-         end_beam ();
-         return;
-       }
+         int durlog  =rhythmic_req->duration_.durlog_i_;
+         if (durlog <= 2)
+           end_beam ();
+         else 
+           {
+             /*
+               if shortest duration would change
+               reconsider ending/starting beam first.
+             */
+             Moment mom = rhythmic_req->duration_.length_mom ();
+             consider_end_and_begin (mom);
+             if (!stem_l_arr_p_)
+               return;
+             if (mom < shortest_mom_)
+               {
+                 if (stem_l_arr_p_->size ())
+                   {
+                     shortest_mom_ = mom;
+                     consider_end_and_begin (shortest_mom_);
+                     if (!stem_l_arr_p_)
+                       return;
+                   }
+                 shortest_mom_ = mom;
+               }
+             Moment now = now_mom ();
 
-      Moment start = get_staff_info().time_C_->whole_in_measure_;
-      if (!grouping_p_->child_fit_b (start))
-       {
-         DOUT << "ending autobeam: stem doesn't fit in group\n";
-         end_beam ();
-       }
-      else
-       {
-         grouping_p_->add_child (start, rhythmic_req->duration ());
-         stem_l->flag_i_ = rhythmic_req->duration_.durlog_i_;
-         beam_p_->add_stem (stem_l);
-         Moment now = now_moment ();
-         last_add_mom_ = now;
-         extend_mom_ = extend_mom_ >? now + rhythmic_req->duration ();
-         mult_i_ = mult_i_ >? (rhythmic_req->duration_.durlog_i_ - 2);
+             grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_, durlog - 2);
+             stem_l_arr_p_->push (stem_l);
+             last_add_mom_ = now;
+             extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
+           }
        }
     }
 }
@@ -254,39 +350,28 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info)
 void
 Auto_beam_engraver::junk_beam () 
 {
-  assert (beam_p_);
-  for (int i=0; i < beam_p_->stems_.size (); i++)
-    {
-      Stem* s = beam_p_->stems_[i];
-      s->beams_i_drul_[LEFT] = 0;
-      s->beams_i_drul_[RIGHT] = 0;
-      s->mult_i_ = 0;
-      s->beam_l_ = 0;
-    }
+  assert (stem_l_arr_p_);
   
-  beam_p_->unlink ();
-  beam_p_ = 0;
+  delete stem_l_arr_p_;
+  stem_l_arr_p_ = 0;
   delete grouping_p_;
   grouping_p_ = 0;
-  mult_i_ = 0;
+  shortest_mom_ = Moment (1, 8);
 }
 
 void
 Auto_beam_engraver::process_acknowledged ()
 {
-  if (beam_p_)
+  if (stem_l_arr_p_)
     {
-      Moment now = now_moment ();
+      Moment now = now_mom ();
       if ((extend_mom_ < now)
          || ((extend_mom_ == now) && (last_add_mom_ != now )))
        {
-         DOUT << String ("junking autobeam: no stem added since: ")
-           + last_add_mom_.str () + "\n";
          end_beam ();
        }
-      else if (!beam_p_->stems_.size ())
+      else if (!stem_l_arr_p_->size ())
        {
-         DOUT << "junking started autobeam: no stems\n";
          junk_beam ();
        }
     }