X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Fauto-beam-engraver.cc;h=aef96d8da5c3387953fd9aa5c9c74429a5e48222;hb=abbdb46061be5c0a0682059d1f86bf3e44ca5cf3;hp=8a22a619977db314a74aa4dee2a9d850a8e09d20;hpb=2873636a53f0011f837aaf6e2072de602730d957;p=lilypond.git

diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc
index 8a22a61997..0472c4cdec 100644
--- a/lily/auto-beam-engraver.cc
+++ b/lily/auto-beam-engraver.cc
@@ -1,410 +1,432 @@
-/*   
-  auto-beam-engraver.cc --  implement Auto_beam_engraver
-  
+/*
+  auto-beam-engraver.cc -- implement Auto_beam_engraver
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
-  
- */
-#include "beaming.hh"
-#include "auto-beam-engraver.hh"
-#include "musical-request.hh"
-#include "bar.hh"
+
+  (c) 1999--2006 Jan Nieuwenhuizen <janneke@gnu.org>
+*/
+
+#include "bar-line.hh"
+#include "beaming-pattern.hh"
 #include "beam.hh"
-#include "chord-tremolo.hh"
+#include "context.hh"
+#include "duration.hh"
+#include "engraver.hh"
+#include "item.hh"
 #include "rest.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
 #include "stem.hh"
-#include "debug.hh"
-#include "timing-engraver.hh"
-#include "engraver-group-engraver.hh"
+#include "warn.hh"
 
-ADD_THIS_TRANSLATOR (Auto_beam_engraver);
+#include "translator.icc"
 
-Auto_beam_engraver::Auto_beam_engraver ()
+class Auto_beam_engraver : public Engraver
 {
-  stem_l_arr_p_ = 0;
-  shortest_mom_ = Moment (1, 8);
-  finished_beam_p_ = 0;
-  finished_grouping_p_ = 0;
-  grouping_p_ = 0;
-  timer_l_ =0;
-}
+  TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
+
+protected:
+  void stop_translation_timestep ();
+  void start_translation_timestep ();
+  void process_music ();
+  virtual void finalize ();
+  virtual void derived_mark () const;
+
+  DECLARE_ACKNOWLEDGER (rest);
+  DECLARE_ACKNOWLEDGER (beam);
+  DECLARE_ACKNOWLEDGER (bar_line);
+  DECLARE_ACKNOWLEDGER (stem);
+  DECLARE_TRANSLATOR_LISTENER (beam_forbid);
+
+  void process_acknowledged ();
+
+private:
+  bool test_moment (Direction, Moment);
+  void consider_begin (Moment);
+  void consider_end (Moment);
+  Spanner *create_beam ();
+  void begin_beam ();
+  void end_beam ();
+  void junk_beam ();
+  bool is_same_grace_state (Grob *e);
+  void typeset_beam ();
+
+  Stream_event *forbid_;
+  /*
+    shortest_mom is the shortest note in the beam.
+  */
+  Moment shortest_mom_;
+  Spanner *finished_beam_;
+  vector<Item*> *stems_;
 
-void
-Auto_beam_engraver::do_creation_processing ()
-{
-  Translator * t = daddy_grav_l  ()->get_simple_translator ("Timing_engraver");
-  timer_l_ = dynamic_cast<Timing_engraver*> (t);
-}
+  int process_acknowledged_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
-Auto_beam_engraver::do_try_music (Music*) 
-{
-  return false;
-} 
+  bool subdivide_beams_;
+  Moment beat_length_;
+
+  // We act as if beam were created, and start a grouping anyway.
+  Beaming_pattern *grouping_;
+  SCM beam_settings_;
+
+  Beaming_pattern *finished_grouping_;
+
+  void check_bar_property ();
+};
 
 void
-Auto_beam_engraver::do_process_requests ()
+Auto_beam_engraver::derived_mark () const
 {
-  consider_end_and_begin (shortest_mom_);
+  scm_gc_mark (beam_settings_);
 }
 
 void
-Auto_beam_engraver::consider_end_and_begin (Moment test_mom)
+Auto_beam_engraver::check_bar_property ()
 {
-  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 ());
-
-  /*
-    URG
-    
-    FIXME: SHOULD USE ALIST
-    
-   */
-
-  /*
-    Determine end moment for auto beaming (and begin, mostly 0==anywhere) 
-    In order of increasing priority:
+  /* Duplicated from process_music (), since
+     Repeat_acknowledge_engraver::process_music () may also set whichBar.  */
 
-    i.   every beat <den>
-    ii.  time<num>_<den>beamAutoEnd
-    iii. time<num>_<den>beamAutoEnd<type>
-    iv.  beamAutoEnd
-    v.   beamAutoEnd<type>
-
-
-    Rationale:
+  Moment now = now_mom ();
+  if (scm_is_string (get_property ("whichBar"))
+      && beam_start_moment_ < now)
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+}
 
-    [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
+void
+Auto_beam_engraver::process_music ()
+{
+  if (scm_is_string (get_property ("whichBar")))
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
 
-    [user override]
-    iv.  generic override
-    v.   override for specific duration type
+  if (forbid_)
+    {
+      consider_end (shortest_mom_);
+      junk_beam ();
+    }
+}
 
-    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_;
+Auto_beam_engraver::Auto_beam_engraver ()
+{
+  forbid_ = 0;
+  process_acknowledged_count_ = 0;
+  stems_ = 0;
+  shortest_mom_ = Moment (Rational (1, 8));
+  finished_beam_ = 0;
+  finished_grouping_ = 0;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;
+}
 
-  /*
-    second guess: property generic time exception
-  */
-  SCM begin = get_property (time_str + "beamAutoBegin", 0);
-  if (SMOB_IS_TYPE_B(Moment, begin))
-    begin_mom = * SMOB_TO_TYPE(Moment, begin);
+IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
+void
+Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
+{
+  ASSIGN_EVENT_ONCE (forbid_, ev);
+}
 
-  SCM end = get_property (time_str + "beamAutoEnd", 0);
-  if (SMOB_IS_TYPE_B (Moment, end))
-    end_mom = * SMOB_TO_TYPE(Moment,end);
+bool
+Auto_beam_engraver::test_moment (Direction dir, Moment test)
+{
+  return scm_call_3 (get_property ("autoBeamCheck"),
+		     context ()->self_scm (),
+		     scm_from_int (dir),
+		     test.smobbed_copy ())
+    != SCM_BOOL_F;
+}
 
-  /*
-    third guess: property time exception, specific for duration type
-  */
-  if (type_str.length_i ())
+void
+Auto_beam_engraver::consider_begin (Moment test_mom)
+{
+  bool on = to_boolean (get_property ("autoBeaming"));
+  if (!stems_ && on
+      && !forbid_)
     {
-      SCM end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0);
-      if (SMOB_IS_TYPE_B (Moment, end_mult))
-	end_mom = * SMOB_TO_TYPE (Moment,end_mult);
-
-      SCM begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0);
-      if (SMOB_IS_TYPE_B (Moment, begin_mult))
-	begin_mom = * SMOB_TO_TYPE (Moment,begin_mult);
+      bool b = test_moment (START, test_mom);
+      if (b)
+	begin_beam ();
     }
+}
 
-  /*
-    fourth guess [user override]: property plain generic
-  */
-  begin = get_property ("beamAutoBegin", 0);
-  if (SMOB_IS_TYPE_B(Moment, begin))
-    begin_mom = * SMOB_TO_TYPE(Moment, begin);
+void
+Auto_beam_engraver::consider_end (Moment test_mom)
+{
+  if (stems_)
+    {
+      /* Allow already started autobeam to end:
+	 don't check for autoBeaming */
+      bool b = test_moment (STOP, test_mom);
+      if (b)
+	end_beam ();
+    }
+}
 
+Spanner *
+Auto_beam_engraver::create_beam ()
+{
+  if (to_boolean (get_property ("skipTypesetting")))
+    return 0;
 
-  
-  end = get_property ("beamAutoEnd", 0);
-  if (SMOB_IS_TYPE_B (Moment, end))
-    end_mom = * SMOB_TO_TYPE (Moment,end);
+  for (vsize i = 0; i < stems_->size (); i++)
+    if (Stem::get_beam ((*stems_)[i]))
+      return 0;
 
   /*
-    fifth guess [user override]: property plain, specific for duration type
+    Can't use make_spanner_from_properties() because we have to use
+    beam_settings_.
   */
-  if (type_str.length_i ())
-    {
-      SCM end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
-      if (SMOB_IS_TYPE_B (Moment, end_mult))
-	end_mom = * SMOB_TO_TYPE (Moment,end_mult);
+  Spanner *beam = new Spanner (beam_settings_,
+			       context ()->get_grob_key ("Beam"));
 
-      SCM begin_mult = get_property (String ("beamAutoBegin") + type_str, 0);
-      if (SMOB_IS_TYPE_B (Moment, begin_mult))
-	begin_mom = * SMOB_TO_TYPE (Moment,begin_mult);
-    }
+  for (vsize i = 0; i < stems_->size (); i++)
+    Beam::add_stem (beam, (*stems_)[i]);
 
-  Rational r;
-  if (end_mom)
-    r = time->whole_in_measure_.mod_rat (end_mom);
-  else
-    r = Moment (1);
+  announce_grob (beam, (*stems_)[0]->self_scm ());
 
-  if (stem_l_arr_p_ && !r)
-    end_beam ();
-     
-  /*
-    Allow already started autobeam to end
-   */
-  SCM on = get_property ("noAutoBeaming", 0);
-  if (gh_boolean_p (on) && gh_scm2bool (on))
-    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;
 }
 
-      
 void
 Auto_beam_engraver::begin_beam ()
 {
-  assert (!stem_l_arr_p_);
-  stem_l_arr_p_ = new Array<Stem*>;
-  assert (!grouping_p_);
-  grouping_p_ = new Beaming_info_list;
+  if (stems_ || grouping_)
+    {
+      programming_error ("already have autobeam");
+      return;
+    }
+
+  stems_ = new vector<Item*>;
+  grouping_ = new Beaming_pattern ();
+  beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
+
   beam_start_moment_ = now_mom ();
-  beam_start_location_ = timer_l_->time_.whole_in_measure_;
+  beam_start_location_
+    = robust_scm2moment (get_property ("measurePosition"), Moment (0));
 }
 
-Beam*
-Auto_beam_engraver::create_beam_p ()
+void
+Auto_beam_engraver::junk_beam ()
 {
-  Beam* beam_p = new Beam;
+  if (!stems_)
+    return;
 
-  for (int i = 0; i < stem_l_arr_p_->size (); i++)
-    {
-      /*
-	watch out for stem tremolos and abbreviation beams
-       */
-      if ((*stem_l_arr_p_)[i]->beam_l_)
-	{
-	  return 0;
-	}
-      beam_p->add_stem ((*stem_l_arr_p_)[i]);
-    }
-  
-  announce_element (Score_element_info (beam_p, 0));
+  delete stems_;
+  stems_ = 0;
+  delete grouping_;
+  grouping_ = 0;
+  beam_settings_ = SCM_EOL;
 
-  return beam_p;
+  shortest_mom_ = Moment (Rational (1, 8));
 }
 
 void
 Auto_beam_engraver::end_beam ()
 {
-  if (stem_l_arr_p_->size () < 2)
-    {
-      junk_beam ();
-    }
+  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 ();
-      finished_beam_p_->set_beaming (finished_grouping_p_);
-      typeset_element (finished_beam_p_);
-      finished_beam_p_ = 0;
-    
-      delete finished_grouping_p_;
-      finished_grouping_p_= 0;
+      if (!finished_beam_->get_bound (RIGHT))
+	finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+      
+      finished_grouping_->beamify (context ());
+      Beam::set_beaming (finished_beam_, finished_grouping_);
+      finished_beam_ = 0;
+
+      delete finished_grouping_;
+      finished_grouping_ = 0;
     }
 }
 
 void
-Auto_beam_engraver::do_post_move_processing ()
+Auto_beam_engraver::start_translation_timestep ()
 {
+  process_acknowledged_count_ = 0;
   /*
     don't beam over skips
-   */
-  if (stem_l_arr_p_)
+  */
+  if (stems_)
     {
       Moment now = now_mom ();
       if (extend_mom_ < now)
-	{
-	  end_beam ();
-	}
+	end_beam ();
     }
+  forbid_ = 0;
 }
 
 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)
+
+void
+Auto_beam_engraver::acknowledge_beam (Grob_info info)
 {
-  bool gr = e->get_elt_property ("grace") == SCM_BOOL_T;
-  SCM wg =get_property ("weAreGraceContext",0);
-  return (gh_boolean_p (wg) && gh_scm2bool (wg)) == gr;
+  (void)info;
+  check_bar_property ();
+  if (stems_)
+    end_beam ();
 }
 
 void
-Auto_beam_engraver::acknowledge_element (Score_element_info info)
+Auto_beam_engraver::acknowledge_bar_line (Grob_info info)
 {
-  if (!same_grace_state_b (info.elem_l_) || !timer_l_)
-    return;
-  
-  if (stem_l_arr_p_)
+  (void)info;
+  check_bar_property ();
+  if (stems_)
+    end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_rest (Grob_info info)
+{
+  (void)info;
+  check_bar_property ();
+  if (stems_)
+    end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_stem (Grob_info info)
+{
+  check_bar_property ();
+  Item *stem = dynamic_cast<Item *> (info.grob ());
+  Stream_event *ev = info.ultimate_event_cause ();
+  if (!ev->in_event_class ("rhythmic-event"))
     {
-      if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
-	{
-	  end_beam ();
-	}
-      else if (Chord_tremolo *b = dynamic_cast<Chord_tremolo*> (info.elem_l_))
-	{
-	  end_beam ();
-	}
-      else if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
-	{
-	  end_beam ();
-	}
-      else if (Rest* rest_l = dynamic_cast<Rest *> (info.elem_l_))
-	{
-	  end_beam ();
-	}
+      programming_error ("stem must have rhythmic structure");
+      return;
     }
-  
-  if (Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_))
+
+  /*
+    Don't (start) auto-beam over empty stems; skips or rests
+  */
+  if (!Stem::head_count (stem))
     {
-      Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
-      if (!rhythmic_req)
-	{
-	  programming_error ("Stem must have rhythmic structure");
-	  return;
-	}
-      
-      /*
-	Don't (start) auto-beam over empty stems; skips or rests
-	*/
-      if (!stem_l->head_l_arr_.size ())
-	{
-	  if (stem_l_arr_p_)
-	    end_beam ();
-	  return;
-	}
+      if (stems_)
+	end_beam ();
+      return;
+    }
 
-      if (stem_l->beam_l_)
-	{
-	  if (stem_l_arr_p_)
-	    junk_beam ();
-	  return ;
-	}
-	      
-      int durlog  =rhythmic_req->duration_.durlog_i_;
-      if (durlog <= 2)
-	{
-	  if (stem_l_arr_p_)
-	    end_beam ();
-	  return;
-	}
+  if (Stem::get_beam (stem))
+    {
+      if (stems_)
+	junk_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_)
-	{
-	  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 ();
-      
-      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 ();
+  int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
+
+  if (durlog <= 2)
+    {
+      if (stems_)
+	end_beam ();
+      return;
     }
-}
 
-void
-Auto_beam_engraver::junk_beam () 
-{
-  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);
+  /*
+    ignore grace notes.
+  */
+  Moment now = now_mom ();
+  if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
+    return;
+
+  Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
+
+  consider_end (dur);
+  consider_begin (dur);
+
+  if (dur < shortest_mom_)
+    shortest_mom_ = dur;
+
+  if (!stems_)
+    return;
+
+  grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
+		       durlog - 2);
+  stems_->push_back (stem);
+  last_add_mom_ = now;
+  extend_mom_ = max (extend_mom_, now) + get_event_length (ev);
 }
 
 void
 Auto_beam_engraver::process_acknowledged ()
 {
-  if (stem_l_arr_p_)
+  if (extend_mom_ > now_mom ())
+    return;
+
+  if (!process_acknowledged_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 (process_acknowledged_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 ();
 	}
     }
+
+  process_acknowledged_count_++;
 }
 
+ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
+ADD_TRANSLATOR (Auto_beam_engraver,
+		/* doc */ "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 @code{stemLeftBeamCount} and "
+		"@code{stemRightBeamCount}. ",
+		/* create */ "Beam",
+		/* accept */ "beam-forbid-event",
+		/* read */ "autoBeaming autoBeamSettings beatLength subdivideBeams",
+		/* write */ "");