X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=94671aabf05b43b3a9dbc2aa418c16d6e2799704;hb=f25fce62a31762d6621272fa7b703cf38d481b3a;hp=3a74ab95cbcecab75d9b6a3256642c5b2cd58907;hpb=d6048913c2c793a6298a3e16a1a25c76711463b1;p=lilypond.git

diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc
index 3a74ab95cb..94671aabf0 100644
--- a/lily/auto-beam-engraver.cc
+++ b/lily/auto-beam-engraver.cc
@@ -3,184 +3,269 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2001 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
 
-#include "auto-beam-engraver.hh"
+#include "beaming.hh"
 #include "musical-request.hh"
-#include "bar.hh"
 #include "beam.hh"
-#include "rhythmic-grouping.hh"
-#include "rest.hh"
 #include "stem.hh"
 #include "debug.hh"
-#include "time-description.hh"
+#include "engraver-group-engraver.hh"
+#include "bar.hh"
+#include "rest.hh"
+#include "engraver.hh"
+#include "item.hh"
+#include "spanner.hh"
+
+/*
+  TODO: figure what to do in grace?
+
+  TODO: documentme.
+ */
+class Auto_beam_engraver : public Engraver
+{
+public:
+  Auto_beam_engraver ();
+  VIRTUAL_COPY_CONS (Translator);
+
+protected:
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void finalize ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual void create_grobs ();
+
+private:
+  bool test_moment (Direction, Moment);
+  void consider_begin (Moment);
+  void consider_end (Moment);
+  Spanner* create_beam_p ();
+  void begin_beam ();
+  void end_beam ();
+  void junk_beam ();
+  bool same_grace_state_b (Grob* e);
+  void typeset_beam ();
+
+  /*
+    shortest_mom is the shortest note in the beam.
+   */
+  Moment shortest_mom_;
+  Spanner *finished_beam_p_;
+  Link_array<Item>* stem_l_arr_p_;
+
+
+  int count_i_;
+  Moment last_add_mom_;
+  /*
+    Projected ending of the  beam we're working on.
+   */
+  Moment extend_mom_;
+  Moment beam_start_moment_;
+  Moment beam_start_location_;
+  
+  // We act as if beam were created, and start a grouping anyway.
+  Beaming_info_list*grouping_p_;  
+  Beaming_info_list*finished_grouping_p_;
+};
 
 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
 
 Auto_beam_engraver::Auto_beam_engraver ()
 {
+  count_i_ = 0;
   stem_l_arr_p_ = 0;
-  shortest_mom_ = 1;
+  shortest_mom_ = Moment (1, 8);
   finished_beam_p_ = 0;
   finished_grouping_p_ = 0;
   grouping_p_ = 0;
 }
 
-void
-Auto_beam_engraver::do_process_requests ()
-{
-  consider_end_and_begin ();
-}
-
-void
-Auto_beam_engraver::consider_end_and_begin ()
+/*
+  Determine end moment for auto beaming (or begin moment, but mostly
+  0==anywhere) In order of increasing priority:
+  
+  i.   begin anywhere, end at every beat
+  ii.  end   *    <num> <den>
+  iii. end <type> <num> <den>
+  
+  iv.  end   *      *     *
+  v.   end <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
+  
+*/
+bool
+Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 {
-  Time_description const *time = get_staff_info().time_C_;
-  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 (shortest_mom_.num () != 1)
-    type_str = to_str (shortest_mom_.num ());
-  if (shortest_mom_.den () != 1)
-    type_str = type_str + "_" + to_str (shortest_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:
+  SCM wild = gh_list (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
+  SCM function;
+  if (dir == START)
+    function = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED);
+  else
+    function = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED);
 
-    [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
+  Moment one_beat = *unsmob_moment (get_property ("beatLength"));
+  int num = *unsmob_moment (get_property ("measureLength")) / one_beat;
+  int den = one_beat.den ();
+  SCM time = gh_list (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED);
 
-    [user override]
-    iv.  generic override
-    v.   override for specific duration type
+  SCM type = gh_list (gh_int2scm (test_mom.num ()),
+		      gh_int2scm (test_mom.den ()), SCM_UNDEFINED);
 
-    The user overrides should be required for common cases.
-   */
+  SCM settings = get_property ("autoBeamSettings");
   
-  /*
-    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_;
+  /* first guess */
+  
+  /* begin beam at any position
+ (and fallback for end) */
+  Moment moment (0);
+  
+  /* end beam at end of beat */
+  if (dir == STOP)
+    {
+      SCM beat (get_property ("beatLength"));
+      
+      if (unsmob_moment (beat))
+	moment = *unsmob_moment (beat);
+    }
 
-  /*
-    second guess: property generic time exception
-  */
-  Scalar begin = get_property (time_str + "beamAutoBegin", 0);
-  if (begin.length_i ())
-    begin_mom = begin.to_rat ();
+  /* second guess: property generic time exception */
+  SCM m = gh_assoc (gh_append3 (function, wild, time), settings);
+  
+  if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m)))
+    moment = * unsmob_moment (gh_cdr (m));
+
+  /* third guess: property time exception, specific for duration type */
+  m = gh_assoc (gh_append3 (function, type, time), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m)))
+    moment = * unsmob_moment (gh_cdr (m));
+
+  /* fourth guess [user override]: property plain generic */
+  m = gh_assoc (gh_append3 (function, wild, wild), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m)))
+    moment = * unsmob_moment (gh_cdr (m));
+
+  /* fifth guess [user override]: property plain, specific for duration type */
+  m = gh_assoc (gh_append3 (function, type, wild), settings);
+  if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m)))
+    moment = * unsmob_moment (gh_cdr (m));
+  
+  Rational r;
+  if (moment)
+    {
+      /* Ugh? measurePosition can be negative, when \partial
+	 We may have to fix this elsewhere (timing translator)
+	r = unsmob_moment (get_property ("measurePosition"))->mod_rat (moment);
+      */
+      Moment pos = * unsmob_moment (get_property ("measurePosition"));
+      if (pos < Moment (0))
+	{
+	  Moment length = * unsmob_moment (get_property ("measureLength"));
+	  pos = length - pos;
+	}
+      r = pos.main_part_.mod_rat (moment.main_part_);
+    }
+  else
+    {
+      if (dir == START)
+	/* if undefined, starting is ok */
+	r = 0;
+      else
+	/* but ending is not */
+	r = 1;
+    }
+  return !r;
+}
 
-  Scalar end = get_property (time_str + "beamAutoEnd", 0);
-  if (end.length_i ())
-    end_mom = end.to_rat ();
+void
+Auto_beam_engraver::consider_begin (Moment test_mom)
+{
+  bool off = to_boolean (get_property ("noAutoBeaming"));
+  if (!stem_l_arr_p_ && ! off)
+    {
+      bool b = test_moment (START, test_mom);
+      if (b)
+	begin_beam ();
+    }
+}
 
-  /*
-    third guess: property time exception, specific for duration type
-  */
-  if (type_str.length_i ())
+void
+Auto_beam_engraver::consider_end (Moment test_mom)
+{
+  if (stem_l_arr_p_)
     {
-      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 ();
+      /* Allow already started autobeam to end:
+	 don't check for noAutoBeaming */
+      bool b = test_moment (STOP, test_mom);
+      if (b)
+	end_beam ();
     }
+}
 
-  /*
-    fourth guess [user override]: property plain generic
-  */
-  begin = get_property ("beamAutoBegin", 0);
-  if (begin.length_i ())
-    begin_mom = begin.to_rat ();
+Spanner*
+Auto_beam_engraver::create_beam_p ()
+{
+  if (to_boolean (get_property ("skipTypesetting")))
+    {
+     return 0;
+    }
   
-  end = get_property ("beamAutoEnd", 0);
-  if (end.length_i ())
-    end_mom = end.to_rat ();
-
-  /*
-    fifth guess [user override]: property plain, specific for duration type
-  */
-  if (type_str.length_i ())
+  Spanner* beam_p = new Spanner (get_property ("Beam"));
+  for (int i = 0; i < stem_l_arr_p_->size (); i++)
     {
-      Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
-      if (end_mult.length_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 ();
+      /*
+	watch out for stem tremolos and abbreviation beams
+       */
+      if (Stem::beam_l ((*stem_l_arr_p_)[i]))
+	{
+	  scm_gc_unprotect_object (beam_p->self_scm ());
+	  return 0;
+	}
+      Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]);
     }
+  
+  announce_grob (beam_p, 0);
 
-  Rational r;
-  if (end_mom)
-    r = time->whole_in_measure_.mod_rat (end_mom);
-  else
-    r = Moment (1);
-
-  if (stem_l_arr_p_ && !r)
-    end_beam ();
-     
-  /*
-    Allow already started autobeam to end
-   */
-  Scalar on = get_property ("beamAuto", 0);
-  if (!on.to_bool ())
-    return;
-
-  if (begin_mom)
-    r = time->whole_in_measure_.mod_rat (begin_mom);
-  if (!stem_l_arr_p_ && (!begin_mom || !r))
-    begin_beam ();
+  return beam_p;
 }
 
-      
 void
 Auto_beam_engraver::begin_beam ()
 {
-  //  DOUT << String ("starting autobeam at: ") + now_mom ().str () + "\n";
   assert (!stem_l_arr_p_);
-  stem_l_arr_p_ = new Array<Stem*>;
+  stem_l_arr_p_ = new Link_array<Item>;
   assert (!grouping_p_);
-  grouping_p_ = new Rhythmic_grouping;
+  grouping_p_ = new Beaming_info_list;
+  beam_start_moment_ = now_mom ();
+  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+
+
 }
 
-Beam*
-Auto_beam_engraver::create_beam_p ()
+
+void
+Auto_beam_engraver::junk_beam () 
 {
-  Beam* beam_p = new Beam;
+  assert (stem_l_arr_p_);
+  
+  delete stem_l_arr_p_;
+  stem_l_arr_p_ = 0;
+  delete grouping_p_;
+  grouping_p_ = 0;
 
-  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 */
-  Scalar prop = get_property ("beamslopedamping", 0);
-  if (prop.isnum_b ()) 
-    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;
- 
-  announce_element (Score_element_info (beam_p, 0));
-  return beam_p;
+  shortest_mom_ = Moment (1, 8);
 }
 
 void
@@ -191,25 +276,27 @@ Auto_beam_engraver::end_beam ()
       junk_beam ();
     }
   else
+    
     {
       finished_beam_p_ = create_beam_p ();
-      finished_grouping_p_ = grouping_p_;
+      if (finished_beam_p_)
+	finished_grouping_p_ = grouping_p_;
       delete stem_l_arr_p_;
       stem_l_arr_p_ = 0;
       grouping_p_ = 0;
-      shortest_mom_ = 1;
     }
+
+  shortest_mom_ = Moment (1, 8);
 }
- 
+
 void
 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_);
-      typeset_element (finished_beam_p_);
+      finished_grouping_p_->beamify ();
+      Beam::set_beaming (finished_beam_p_, finished_grouping_p_);
+      typeset_grob (finished_beam_p_);
       finished_beam_p_ = 0;
     
       delete finished_grouping_p_;
@@ -218,134 +305,172 @@ Auto_beam_engraver::typeset_beam ()
 }
 
 void
-Auto_beam_engraver::do_post_move_processing ()
+Auto_beam_engraver::start_translation_timestep ()
 {
+  count_i_ = 0;
+  /*
+    don't beam over skips
+   */
+  if (stem_l_arr_p_)
+    {
+      Moment now = now_mom ();
+      if (extend_mom_ < now)
+	{
+	  end_beam ();
+	}
+    }
 }
 
 void
-Auto_beam_engraver::do_pre_move_processing ()
+Auto_beam_engraver::stop_translation_timestep ()
 {
+  
   typeset_beam ();
 }
 
 void
-Auto_beam_engraver::do_removal_processing ()
+Auto_beam_engraver::finalize ()
 {
+  /* finished beams may be typeset */
   typeset_beam ();
-  if (stem_l_arr_p_ && stem_l_arr_p_->size ())
-    {
-      junk_beam ();
-    }
+  /* but unfinished may need another announce/acknowledge pass */
+  if (stem_l_arr_p_)
+    junk_beam ();
 }
 
+
 void
-Auto_beam_engraver::acknowledge_element (Score_element_info info)
+Auto_beam_engraver::acknowledge_grob (Grob_info info)
 {
-  if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
+  if (stem_l_arr_p_)
     {
-      if (stem_l_arr_p_)
+      if (Beam::has_interface (info.elem_l_))
 	{
-	  junk_beam ();
+	  end_beam ();
 	}
-    }
-  if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
-    {
-      if (stem_l_arr_p_)
+      else if (Bar::has_interface (info.elem_l_))
+	{
+	  end_beam ();
+	}
+      else if (Rest::has_interface (info.elem_l_))
 	{
-	  junk_beam ();
+	  end_beam ();
 	}
     }
-
-  if (stem_l_arr_p_)
+  
+  if (Stem::has_interface (info.elem_l_))
     {
+      Item* stem_l = dynamic_cast<Item *> (info.elem_l_);
+				       
       Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
       if (!rhythmic_req)
-	return;
-
-      if (dynamic_cast<Rest *> (info.elem_l_))
 	{
-	  end_beam ();
+	  programming_error ("Stem must have rhythmic structure");
 	  return;
 	}
-
-      Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_);
-      if (!stem_l)
-	return;
-
-      if (stem_l->beam_l_)
+      
+      /*
+	Don't (start) auto-beam over empty stems; skips or rests
+	*/
+      if (!Stem::heads_i (stem_l))
 	{
-	  junk_beam ();
+	  if (stem_l_arr_p_)
+	    end_beam ();
 	  return;
 	}
-	
 
-      /*
-	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)
+      if (Stem::beam_l (stem_l))
 	{
-	  end_beam ();
+	  if (stem_l_arr_p_)
+	    junk_beam ();
+	  return ;
+	}
+	      
+      int durlog  = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log ();
+      
+      if (durlog <= 2)
+	{
+	  if (stem_l_arr_p_)
+	    end_beam ();
 	  return;
 	}
 
-      Moment start = get_staff_info().time_C_->whole_in_measure_;
-      if (!grouping_p_->child_fit_b (start))
+
+      /*
+	ignore grace notes.
+       */
+      if (bool (beam_start_location_.grace_mom_) != bool (now_mom ().grace_mom_))
+	return ;
+	
+      
+      Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom ();
+      /* FIXME:
+
+	This comment has been here since long:
+
+	   if shortest duration would change
+	    consider ending and beginning beam first. 
+
+	but the code didn't match: */
+#if 1
+      consider_end (dur);
+      consider_begin (dur);
+
+      if (dur < shortest_mom_)
+	shortest_mom_ = dur;
+#else
+      /* I very much suspect that we wanted: */
+
+      consider_end (shortest_mom_);
+      if (dur < shortest_mom_)
 	{
-	  end_beam ();
+	  shortest_mom_ = dur;
+	  consider_end (shortest_mom_);
 	}
-      else
-	{
-	  /*
-	    if shortest duration would change
-	    reconsider ending/starting beam first.
-	   */
-	  Moment mom = rhythmic_req->duration_.length_mom ();
-	  if (mom < shortest_mom_)
-	    {
-	      shortest_mom_ = mom;
-	      consider_end_and_begin ();
-	    }
-	  grouping_p_->add_child (start, rhythmic_req->length_mom ());
+      consider_begin (shortest_mom_);
+#endif
 
-	  //stem_l->flag_i_ = rhythmic_req->duration_.durlog_i_;
-	  
-	  stem_l_arr_p_->push (stem_l);
-	  Moment now = now_mom ();
-	  last_add_mom_ = now;
-	  extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
-	}
+      if (!stem_l_arr_p_)
+	return;
+      
+      Moment now = now_mom ();
+      
+      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 ();
     }
 }
 
 void
-Auto_beam_engraver::junk_beam () 
-{
-  assert (stem_l_arr_p_);
-  /*  for (int i = 0; i < stem_l_arr_p_->size (); i++)
-      (*stem_l_arr_p_)[i]->flag_i_ = 0;*/
-  
-  delete stem_l_arr_p_;
-  stem_l_arr_p_ = 0;
-  delete grouping_p_;
-  grouping_p_ = 0;
-  shortest_mom_ = 1;
-}
-
-void
-Auto_beam_engraver::process_acknowledged ()
+Auto_beam_engraver::create_grobs ()
 {
-  if (stem_l_arr_p_)
+  if (!count_i_)
     {
-      Moment now = now_mom ();
-      if ((extend_mom_ < now)
-	  || ((extend_mom_ == now) && (last_add_mom_ != now )))
-	{
-	  end_beam ();
-	}
-      else if (!stem_l_arr_p_->size ())
+      consider_end (shortest_mom_);
+      consider_begin (shortest_mom_);
+    }
+  else if (count_i_ > 1)
+    {
+      if (stem_l_arr_p_)
 	{
-	  junk_beam ();
-	}
+	  Moment now = now_mom ();
+	  if ((extend_mom_ < now)
+	      || ((extend_mom_ == now) && (last_add_mom_ != now)))
+	    {
+	      end_beam ();
+	    }
+	  else if (!stem_l_arr_p_->size ())
+	    {
+	      junk_beam ();
+	    }
+	}    
     }
+
+  /*
+    count_i_++ -> 
+
+        auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */
+  count_i_ = count_i_ + 1;
 }