X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=5942c9461b14047c5ff3127b008c6fe34fdad340;hb=e1d47884955f31275ebb0972a08efd1d9d0457dc;hp=62fa32579a8b22e9e801430cd17b6f1b74d834bc;hpb=d8ddee6490dd1bb4965980d3e952a390493bfffd;p=lilypond.git

diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc
index 62fa32579a..5942c9461b 100644
--- a/lily/auto-beam-engraver.cc
+++ b/lily/auto-beam-engraver.cc
@@ -3,296 +3,331 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2000 Jan Nieuwenhuizen <janneke@gnu.org>
+  (c) 1999--2002 Jan Nieuwenhuizen <janneke@gnu.org>
   
  */
 
 #include "beaming.hh"
-#include "musical-request.hh"
+#include "event.hh"
 #include "beam.hh"
 #include "stem.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "engraver-group-engraver.hh"
-#include "bar.hh"
+#include "bar-line.hh"
 #include "rest.hh"
 #include "engraver.hh"
 #include "item.hh"
 #include "spanner.hh"
+#include "duration.hh"
 
 /*
   TODO: figure what to do in grace?
+
+  TODO: documentme.
  */
 class Auto_beam_engraver : public Engraver
 {
-public:
-  Auto_beam_engraver ();
-  VIRTUAL_COPY_CONS (Translator);
-
+  TRANSLATOR_DECLARATIONS(Auto_beam_engraver);
 protected:
-  virtual bool do_try_music (Music*);
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void do_removal_processing ();
-  virtual void acknowledge_element (Score_element_info);
-  virtual void do_process_music ();
-  virtual void process_acknowledged ();
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void finalize ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual void process_acknowledged_grobs ();
+
 private:
+  bool test_moment (Direction, Moment);
+  void consider_begin (Moment);
+  void consider_end (Moment);
+  Spanner* create_beam ();
   void begin_beam ();
-  void consider_end_and_begin (Moment test_mom);
-  Spanner* create_beam_p ();
   void end_beam ();
   void junk_beam ();
-  bool same_grace_state_b (Score_element* e);
+  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_;
-  
+  Spanner *finished_beam_;
+  Link_array<Item>* stems_;
+
+
+  int count_;
   Moment last_add_mom_;
+  /*
+    Projected ending of the  beam we're working on.
+   */
   Moment extend_mom_;
   Moment beam_start_moment_;
   Moment beam_start_location_;
+
+  bool subdivide_beams_;
+  Moment beat_length_;
   
   // We act as if beam were created, and start a grouping anyway.
-  Beaming_info_list*grouping_p_;  
-  Beaming_info_list*finished_grouping_p_;
+  Beaming_info_list*grouping_;
+  SCM beam_settings_ ;		// ugh. should protect ? 
+  
+  Beaming_info_list*finished_grouping_;
 };
 
-ADD_THIS_TRANSLATOR (Auto_beam_engraver);
+
 
 Auto_beam_engraver::Auto_beam_engraver ()
 {
-  stem_l_arr_p_ = 0;
-  shortest_mom_ = Moment (1, 8);
-  finished_beam_p_ = 0;
-  finished_grouping_p_ = 0;
-  grouping_p_ = 0;
+  count_ = 0;
+  stems_ = 0;
+  shortest_mom_ = Moment (Rational (1, 8));
+  finished_beam_ = 0;
+  finished_grouping_ = 0;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;  
 }
 
+/*
+  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::do_try_music (Music*) 
-{
-  return false;
-} 
-
-void
-Auto_beam_engraver::do_process_music ()
+Auto_beam_engraver::test_moment (Direction dir, Moment test_mom)
 {
-  consider_end_and_begin (shortest_mom_);
-}
-
-void
-Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
-{
-  Moment one_beat = *unsmob_moment( get_property ("beatLength"));
-
-  int num = *unsmob_moment (get_property("measureLength")) / one_beat;
-  int den = one_beat.den_i ();
+  Moment now = now_mom();
+  if (dir == START
+      && now.grace_part_)
+    {
+      return false;
+    }
   
-  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 ());
-
-  /*
-    URG
-    
-    FIXME: SHOULD USE ALIST
-    
-   */
-
-  /*
-    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 = scm_list_n (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED);
+  SCM function;
+  if (dir == START)
+    function = scm_list_n (ly_symbol2scm ("begin"), SCM_UNDEFINED);
+  else
+    function = scm_list_n (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 = int ((*unsmob_moment (get_property ("measureLength")) / one_beat).main_part_);
+  int den = one_beat.den ();
+  SCM time = scm_list_n (scm_int2num (num), scm_int2num (den), SCM_UNDEFINED);
 
-    [user override]
-    iv.  generic override
-    v.   override for specific duration type
+  SCM type = scm_list_n (scm_int2num (test_mom.num ()),
+		      scm_int2num (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
-  */
-  SCM one (get_property ("beatLength"));
-
-  Moment end_mom;
-  if (unsmob_moment (one))
-    end_mom = *unsmob_moment (one);
-
-  /*
-    second guess: property generic time exception
-  */
-  SCM begin = get_property ((time_str + "beamAutoBegin").ch_C());
-  if (unsmob_moment (begin))
-    begin_mom = * unsmob_moment (begin);
-
-  SCM end = get_property ((time_str + "beamAutoEnd").ch_C());
-  if (unsmob_moment (end))
-    end_mom = * unsmob_moment (end);
-
-  /*
-    third guess: property time exception, specific for duration type
-  */
-  if (type_str.length_i ())
+  /* first guess */
+  
+  /* begin beam at any position
+ (and fallback for end) */
+  Moment moment (0);
+  
+  /* end beam at end of beat */
+  if (dir == STOP)
     {
-      SCM end_mult = get_property ((time_str + "beamAutoEnd" + type_str).ch_C());
-      if (unsmob_moment (end_mult))
-	end_mom = * unsmob_moment (end_mult);
-
-      SCM begin_mult = get_property ((time_str + "beamAutoBegin" + type_str).ch_C());
-      if (unsmob_moment (begin_mult))
-	begin_mom = * unsmob_moment (begin_mult);
+      SCM beat (get_property ("beatLength"));
+      
+      if (unsmob_moment (beat))
+	moment = *unsmob_moment (beat);
     }
 
-  /*
-    fourth guess [user override]: property plain generic
-  */
-  begin = get_property ("beamAutoBegin");
-  if (unsmob_moment (begin))
-    begin_mom = * unsmob_moment (begin);
-
-
+  /* second guess: property generic time exception */
+  SCM m = gh_assoc (gh_append3 (function, wild, time), settings);
   
-  end = get_property ("beamAutoEnd");
-  if (unsmob_moment (end))
-    end_mom = * unsmob_moment (end);
-
-  /*
-    fifth guess [user override]: property plain, specific for duration type
-  */
-  if (type_str.length_i ())
+  if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m)))
+    moment = * unsmob_moment (ly_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 (ly_cdr (m)))
+    moment = * unsmob_moment (ly_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 (ly_cdr (m)))
+    moment = * unsmob_moment (ly_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 (ly_cdr (m)))
+    moment = * unsmob_moment (ly_cdr (m));
+  
+  Rational r;
+  if (moment.to_bool ())
     {
-      SCM end_mult = get_property ((String ("beamAutoEnd") + type_str).ch_C());
-      if (unsmob_moment (end_mult))
-	end_mom = * unsmob_moment (end_mult);
-
-      SCM begin_mult = get_property ((String ("beamAutoBegin") + type_str).ch_C());
-      if (unsmob_moment (begin_mult))
-	begin_mom = * unsmob_moment (begin_mult);
+      /* 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_);
     }
-
-  Rational r;
-  if (end_mom)
-    r = unsmob_moment (get_property ("measurePosition"))->mod_rat (end_mom);
   else
-    r = Moment (1);
+    {
+      if (dir == START)
+	/* if undefined, starting is ok */
+	r = 0;
+      else
+	/* but ending is not */
+	r = 1;
+    }
 
-  if (stem_l_arr_p_ && !r)
-    end_beam ();
-     
-  /*
-    Allow already started autobeam to end
-   */
-  SCM on = get_property ("noAutoBeaming");
-  if (to_boolean (on))
-    return;
-
-  if (begin_mom)
-    r = unsmob_moment (get_property ("measurePosition"))->mod_rat (begin_mom);
-  if (!stem_l_arr_p_ && (!begin_mom || !r))
-    begin_beam ();
+  return !r;
 }
 
-      
 void
-Auto_beam_engraver::begin_beam ()
+Auto_beam_engraver::consider_begin (Moment test_mom)
 {
-  assert (!stem_l_arr_p_);
-  stem_l_arr_p_ = new Link_array<Item>;
-  assert (!grouping_p_);
-  grouping_p_ = new Beaming_info_list;
-  beam_start_moment_ = now_mom ();
-  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+  bool on = to_boolean (get_property ("autoBeaming"));
+  if (!stems_ && on)
+    {
+      bool b = test_moment (START, test_mom);
+      if (b)
+	begin_beam ();
+    }
 }
 
-Spanner*
-Auto_beam_engraver::create_beam_p ()
+void
+Auto_beam_engraver::consider_end (Moment test_mom)
 {
-  Spanner* beam_p = new Spanner (get_property ("Beam"));
-  Beam::set_interface (beam_p);
+  if (stems_)
+    {
+      /* Allow already started autobeam to end:
+	 don't check for autoBeaming */
+      bool b = test_moment (STOP, test_mom);
+      if (b)
+	end_beam ();
+    }
+}
 
-  for (int i = 0; i < stem_l_arr_p_->size (); i++)
+Spanner*
+Auto_beam_engraver::create_beam ()
+{
+  if (to_boolean (get_property ("skipTypesetting")))
+    {
+     return 0;
+    }
+  
+  Spanner* beam = new Spanner (beam_settings_);
+  for (int i = 0; i < stems_->size (); i++)
     {
       /*
 	watch out for stem tremolos and abbreviation beams
        */
-      if (Stem::beam_l ((*stem_l_arr_p_)[i]))
+      if (Stem::get_beam ((*stems_)[i]))
 	{
+	  scm_gc_unprotect_object (beam->self_scm ());
 	  return 0;
 	}
-      Beam::add_stem (beam_p,(*stem_l_arr_p_)[i]);
+      Beam::add_stem (beam, (*stems_)[i]);
     }
   
-  announce_element (beam_p, 0);
+  announce_grob(beam, SCM_EOL);
 
-  return beam_p;
+  return beam;
+}
+
+void
+Auto_beam_engraver::begin_beam ()
+{
+  assert (!stems_);
+  stems_ = new Link_array<Item>;
+  assert (!grouping_);
+  grouping_ = new Beaming_info_list;
+  beam_settings_ = get_property ("Beam");
+  
+  beam_start_moment_ = now_mom ();
+  beam_start_location_ = *unsmob_moment (get_property ("measurePosition"));
+  subdivide_beams_ = gh_scm2bool(get_property("subdivideBeams"));
+  beat_length_ = *unsmob_moment (get_property ("beatLength"));
+}
+
+
+void
+Auto_beam_engraver::junk_beam () 
+{
+  assert (stems_);
+  
+  delete stems_;
+  stems_ = 0;
+  delete grouping_;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;
+  
+  shortest_mom_ = Moment (Rational (1, 8));
 }
 
 void
 Auto_beam_engraver::end_beam ()
 {
-  if (stem_l_arr_p_->size () < 2)
+  if (stems_->size () < 2)
     {
       junk_beam ();
     }
   else
+    
     {
-      finished_beam_p_ = create_beam_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_ = Moment (1, 8);
+      finished_beam_ = create_beam ();
+      if (finished_beam_)
+	finished_grouping_ = grouping_;
+      delete stems_;
+      stems_ = 0;
+      grouping_ = 0;
+      beam_settings_ = SCM_EOL;
     }
+
+  shortest_mom_ = Moment (Rational (1, 8));
 }
- 
+
 void
 Auto_beam_engraver::typeset_beam ()
 {
-  if (finished_beam_p_)
+  if (finished_beam_)
     {
-      finished_grouping_p_->beamify ();
-      Beam::set_beaming (finished_beam_p_, finished_grouping_p_);
-      typeset_element (finished_beam_p_);
-      finished_beam_p_ = 0;
+      finished_grouping_->beamify(beat_length_, subdivide_beams_);
+      Beam::set_beaming (finished_beam_, finished_grouping_);
+      typeset_grob (finished_beam_);
+      finished_beam_ = 0;
     
-      delete finished_grouping_p_;
-      finished_grouping_p_= 0;
+      delete finished_grouping_;
+      finished_grouping_= 0;
     }
 }
 
 void
-Auto_beam_engraver::do_post_move_processing ()
+Auto_beam_engraver::start_translation_timestep ()
 {
+  count_ = 0;
   /*
     don't beam over skips
    */
-  if (stem_l_arr_p_)
+  if (stems_)
     {
       Moment now = now_mom ();
       if (extend_mom_ < now)
@@ -303,57 +338,46 @@ Auto_beam_engraver::do_post_move_processing ()
 }
 
 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 ();
   /* but unfinished may need another announce/acknowledge pass */
-  if (stem_l_arr_p_)
+  if (stems_)
     junk_beam ();
 }
 
-bool
-Auto_beam_engraver::same_grace_state_b (Score_element* e)
-{
-  bool gr = e->get_elt_property ("grace") == SCM_BOOL_T;
-  SCM wg =get_property ("weAreGraceContext");
-  return (to_boolean (wg)) == gr;
-}
 
 void
-Auto_beam_engraver::acknowledge_element (Score_element_info info)
+Auto_beam_engraver::acknowledge_grob (Grob_info info)
 {
-  if (!same_grace_state_b (info.elem_l_))
-    return;
-  
-  if (stem_l_arr_p_)
+  if (stems_)
     {
-      if (Beam::has_interface (info.elem_l_))
+      if (Beam::has_interface (info.grob_))
 	{
 	  end_beam ();
 	}
-      else if (Bar::has_interface (info.elem_l_))
+      else if (Bar_line::has_interface (info.grob_))
 	{
 	  end_beam ();
 	}
-      else if (Rest::has_interface (info.elem_l_))
+      else if (Rest::has_interface (info.grob_))
 	{
 	  end_beam ();
 	}
     }
   
-  if (Stem::has_interface (info.elem_l_))
+  if (Stem::has_interface (info.grob_))
     {
-      Item* stem_l = dynamic_cast<Item *> (info.elem_l_);
-				       
-      Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
-      if (!rhythmic_req)
+      Item* stem = dynamic_cast<Item *> (info.grob_);
+      Music* m = info.music_cause ();
+      if (!m->is_mus_type ("rhythmic-event"))
 	{
 	  programming_error ("Stem must have rhythmic structure");
 	  return;
@@ -362,83 +386,118 @@ Auto_beam_engraver::acknowledge_element (Score_element_info info)
       /*
 	Don't (start) auto-beam over empty stems; skips or rests
 	*/
-      if (!Stem::heads_i (stem_l))
+      if (!Stem::head_count (stem))
 	{
-	  if (stem_l_arr_p_)
+	  if (stems_)
 	    end_beam ();
 	  return;
 	}
 
-      if (Stem::beam_l (stem_l))
+      if (Stem::get_beam (stem))
 	{
-	  if (stem_l_arr_p_)
+	  if (stems_)
 	    junk_beam ();
 	  return ;
 	}
 	      
-      int durlog  =rhythmic_req->duration_.durlog_i_;
+      int durlog  = unsmob_duration (m->get_mus_property ("duration"))->duration_log ();
+      
       if (durlog <= 2)
 	{
-	  if (stem_l_arr_p_)
+	  if (stems_)
 	    end_beam ();
 	  return;
 	}
 
+
       /*
-	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_)
+	ignore grace notes.
+       */
+      if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_))
+	return ;
+	
+      
+      Moment dur = unsmob_duration (m->get_mus_property ("duration"))->get_length ();
+      /* 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_)
 	{
-	  if (stem_l_arr_p_->size ())
-	    {
-	      shortest_mom_ = mom;
-	      consider_end_and_begin (shortest_mom_);
-	      if (!stem_l_arr_p_)
-		return;
-	    }
-	  shortest_mom_ = mom;
+	  shortest_mom_ = dur;
+	  consider_end (shortest_mom_);
 	}
+      consider_begin (shortest_mom_);
+#endif
+
+      if (!stems_)
+	return;
+      
       Moment now = now_mom ();
       
-      grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_,
+      grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
 			     durlog - 2);
-      stem_l_arr_p_->push (stem_l);
+      stems_->push (stem);
       last_add_mom_ = now;
-      extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
+      extend_mom_ = (extend_mom_ >? now) + m->get_length ();
     }
 }
 
 void
-Auto_beam_engraver::junk_beam () 
+Auto_beam_engraver::process_acknowledged_grobs ()
 {
-  assert (stem_l_arr_p_);
-  
-  delete stem_l_arr_p_;
-  stem_l_arr_p_ = 0;
-  delete grouping_p_;
-  grouping_p_ = 0;
-  shortest_mom_ = Moment (1, 8);
-}
-
-void
-Auto_beam_engraver::process_acknowledged ()
-{
-  if (stem_l_arr_p_)
+  if (!count_)
     {
-      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_ > 1)
+    {
+      if (stems_)
 	{
-	  junk_beam ();
-	}
+	  Moment now = now_mom ();
+	  if ((extend_mom_ < now)
+	      || ((extend_mom_ == now) && (last_add_mom_ != now)))
+	    {
+	      end_beam ();
+	    }
+	  else if (!stems_->size ())
+	    {
+	      junk_beam ();
+	    }
+	}    
     }
+
+  /*
+    count_++ -> 
+
+        auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */
+  count_ = count_ + 1;
 }
+
+ENTER_DESCRIPTION (Auto_beam_engraver,
+/* descr */       "Generate beams based on measure characteristics and observed "
+"Stems.  Uses beatLength, measureLength and measurePosition to decide "
+"when to start and stop a beam.  Overriding beaming is done through "
+"@ref{Stem_engraver} properties stemLeftBeamCount and "
+"stemRightBeamCount. "
+,
+/* creats*/       "Beam",
+/* accepts */     "",
+/* acks  */      "stem-interface rest-interface beam-interface bar-line-interface",
+/* reads */       "autoBeaming autoBeamSettings beatLength subdivideBeams",
+/* write */       "");