X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpiano-pedal-engraver.cc;h=77283f3bce6442ec8bcaa617e1b5cd8b50cd12fe;hb=402045837e7134cdf90d1fcf31768c62227a4936;hp=b8a69703a7f9a9e985ca67bf98d6bdaa217b2611;hpb=f5e5c04d731e93b1d8d4cf7e7697f71f6e7c2bdf;p=lilypond.git

diff --git a/lily/piano-pedal-engraver.cc b/lily/piano-pedal-engraver.cc
index b8a69703a7..77283f3bce 100644
--- a/lily/piano-pedal-engraver.cc
+++ b/lily/piano-pedal-engraver.cc
@@ -3,141 +3,172 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 2000 Jan Nieuwenhuizen <janneke@gnu.org>
- */
+ (c) 2000--2004 Jan Nieuwenhuizen <janneke@gnu.org>
+  
+  Chris Jackson <chris@fluffhouse.org.uk> - extended to support
+  bracketed pedals.
+*/
 
 #include "engraver.hh"
-#include "musical-request.hh"
-#include "score-element.hh"
+#include "event.hh"
+#include "grob.hh"
 #include "item.hh"
-#include "lookup.hh"
 #include "lily-guile.hh"
-#include "note-head.hh"
-#include "stem.hh"
 #include "side-position-interface.hh"
 #include "staff-symbol-referencer.hh"
-#include "text-item.hh"
-#include "sustain-pedal.hh"
+#include "item.hh"
+#include "axis-group-interface.hh"
+#include "translator-group.hh"
+#include "directional-element-interface.hh"
+#include "note-column.hh"
+#include "warn.hh"
 
 /*
-   TODO:
-     * it would be really cool if an engraver could be initialised with a
-       string, ie:
+  Urgh. This engraver is too complex. rewrite. --hwn
+
+*/
 
-          Piano_pedal_engraver::"sostenuto"
-          Piano_pedal_engraver::"sustain"
-          Piano_pedal_engraver::"una-chorda"
+struct Pedal_info
+{
+  char const * name_;
 
- */
+  /*
+    Event for currently running pedal.
+  */
+  Music* current_bracket_ev_;
 
-/*
-  Would it? The semantics are unclear, and real benefits are muddy
-  too.  --hwn
-*/
+  /*
+    Event for currently starting pedal, (necessary?
+    
+    distinct from current_bracket_ev_, since current_bracket_ev_ only
+    necessary for brackets, not for text style.
+   */
+  Music* start_ev_;
 
 
+  
+  /*
+    Events that were found in this timestep.
+   */
+  Drul_array<Music*> event_drul_;
+  Item* item_;
+  Spanner* bracket_;     // A single portion of a pedal bracket
+  Spanner* finished_bracket_;
+
+  /*
+    This grob contains all the pedals of the same type on the same staff
+   */
+  Spanner* line_spanner_;
+  Spanner* finished_line_spanner_;
+};
+
 
-/**
-   engrave Piano pedals symbols.
- */
 class Piano_pedal_engraver : public Engraver
 {
 public:
-  VIRTUAL_COPY_CONS (Translator);
-  Piano_pedal_engraver ();
+  TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
   ~Piano_pedal_engraver ();
 protected:
-  virtual void do_creation_processing ();
-  virtual bool do_try_music (Music*);
-  virtual void do_process_music ();
-  virtual void do_pre_move_processing ();
-  virtual void do_post_move_processing ();
-  virtual void acknowledge_element (Score_element_info);
+  virtual void initialize ();
+  virtual void finalize ();
+  virtual bool try_music (Music*);
+  virtual void stop_translation_timestep ();
+  virtual void acknowledge_grob (Grob_info);
+  virtual void process_music ();
 
 private:
-  struct Pedal_info
-  {
-    char const * name_;
-    Span_req* start_req_l_;
-    Drul_array<Span_req*> req_l_drul_;
-    Item* item_p_;
-  };
-
 
   Pedal_info *info_list_;
+
+  /*
+    Record a stack of the current pedal spanners, so if more than one pedal
+    occurs simultaneously then extra space can be added between them.
+  */
+  
+  Link_array<Spanner> previous_;
+  
+  void create_text_grobs (Pedal_info *p, bool);
+  void create_bracket_grobs (Pedal_info *p, bool);
+  void typeset_all ();
 };
 
-ADD_THIS_TRANSLATOR (Piano_pedal_engraver);
 
 Piano_pedal_engraver::Piano_pedal_engraver ()
 {
   info_list_ = 0;
 }
+
 void
-Piano_pedal_engraver::do_creation_processing()
+Piano_pedal_engraver::initialize ()
 {
-  info_list_ = new Pedal_info[4];
-  Pedal_info *p = info_list_;
+  previous_.clear ();
+
+  char * names [] = { "Sostenuto", "Sustain", "UnaCorda", 0  };
 
+  info_list_ = new Pedal_info[sizeof (names)/ sizeof (const char*)]; 
+  Pedal_info *p = info_list_;
 
-  char * names [] = { "Sostenuto", "Sustain", "UnaChorda", 0  };
   char **np = names ;
   do
     {
       p->name_ = *np;
-      p->item_p_ = 0;
-      p->req_l_drul_[START] = 0;
-      p->req_l_drul_[STOP] = 0;
-      p->start_req_l_ = 0;
+      p->item_ = 0;
+      p->bracket_ = 0;
+      p->finished_bracket_ = 0;
+      p->line_spanner_ = 0;
+      p->finished_line_spanner_ = 0;
+      p->current_bracket_ev_ = 0;
+      p->event_drul_[START] = 0;
+      p->event_drul_[STOP] = 0;
+      p->start_ev_ = 0;
 
       p++;
     }
-  while (*(np ++));
+  while (* (np ++));
 }
 
-Piano_pedal_engraver::~Piano_pedal_engraver()
+Piano_pedal_engraver::~Piano_pedal_engraver ()
 {
   delete[] info_list_;
 }
 
 /*
-  Urg: Code dup
-  I'm a script
- */
+   Urg: Code dup
+   I'm a script
+  */
 void
-Piano_pedal_engraver::acknowledge_element (Score_element_info info)
+Piano_pedal_engraver::acknowledge_grob (Grob_info info)
 {
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
     {
-      if (p->item_p_)
+      if (Note_column::has_interface (info.grob_))
 	{
-	  if (Note_head* n = dynamic_cast<Note_head*> (info.elem_l_))
+	  if (p->line_spanner_)
 	    {
-	      Side_position_interface st (p->item_p_);
-	      st.add_support (n);
-	      if (st.get_axis( ) == X_AXIS
-		  && !p->item_p_->parent_l (Y_AXIS))
-		p->item_p_->set_parent (n, Y_AXIS);
-	    }
-	  if (Stem* s = dynamic_cast<Stem*> (info.elem_l_))
-	    {
-	      Side_position_interface st (p->item_p_);
-	      st.add_support (s);
-	    }
+	      Side_position_interface::add_support (p->line_spanner_, info.grob_);
+	      add_bound_item (p->line_spanner_,info.grob_);
+	    }	  
+	  if (p->bracket_)
+	    add_bound_item (p->bracket_,info.grob_);
+	  if (p->finished_bracket_)
+	    add_bound_item (p->finished_bracket_,info.grob_);		  
 	}
     }
 }
 
 bool
-Piano_pedal_engraver::do_try_music (Music *m)
+Piano_pedal_engraver::try_music (Music *m)
 {
-  if (Span_req * s = dynamic_cast<Span_req*>(m))
+ if  (m->is_mus_type ("pedal-event"))
     {
       for (Pedal_info*p = info_list_; p->name_; p ++)
 	{
-	  if (s->span_type_str_ == p->name_)
+	  String nm = p->name_ + String ("Event");
+	  if (gh_equal_p (m->get_mus_property ("name") ,
+			  gh_symbol2scm (nm.to_str0())))
 	    {
-	      p->req_l_drul_[s->span_dir_] = s;
+	      Direction d = to_dir (m->get_mus_property ("span-direction"));
+	      p->event_drul_[d] = m;
 	      return true;
 	    }
 	}
@@ -146,107 +177,384 @@ Piano_pedal_engraver::do_try_music (Music *m)
 }
 
 void
-Piano_pedal_engraver::do_process_music ()
+Piano_pedal_engraver::process_music ()
 {
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
     {
-      SCM s = SCM_UNDEFINED;
-      if (p->req_l_drul_[STOP] && p->req_l_drul_[START])
+      if (p->event_drul_[STOP] || p->event_drul_[START])
 	{
-	  if (!p->start_req_l_)
+	  if (!p->line_spanner_)
 	    {
-	      p->req_l_drul_[STOP]->warning (_f ("can't find start of piano pedal: %s",  p->name_ ));
+	      String name  = String (p->name_) + "PedalLineSpanner";
+	      p->line_spanner_ = make_spanner (name.to_str0 ());
+
+	      Music * rq = (p->event_drul_[START]  ?  p->event_drul_[START]  :  p->event_drul_[STOP]);
+	      announce_grob (p->line_spanner_, rq->self_scm ());
 	    }
-	  else
+      
+	  /* Choose the appropriate grobs to add to the line spanner
+	   These can be text items or text-spanners
+	  */
+
+	  /*
+	    ugh, code dup, should read grob to create from other
+	    property.
+
+	      bracket: |_________/\____|
+	      text:    Ped.     *Ped.  *
+	      mixed:   Ped. _____/\____|
+	   */
+
+
+	  String prop = String ("pedal")  + p->name_ + "Style";
+	  SCM style = get_property (prop.to_str0 ());
+	  bool mixed = style == ly_symbol2scm ("mixed");
+	  if (style == ly_symbol2scm ("text") ||
+	      mixed)    
 	    {
-	      s = get_property ("stopStart" + String (p->name_ ));
+	      if (! p->item_)
+		create_text_grobs (p, mixed);
 	    }
-	  p->start_req_l_ = p->req_l_drul_[START];
+	  if (style == ly_symbol2scm ("bracket") ||
+	      mixed)
+	   {
+	     create_bracket_grobs (p, mixed);
+	   }
 	}
-      else if (p->req_l_drul_[STOP])
+    }
+}
+
+void
+Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
+{
+  SCM s = SCM_EOL;
+  SCM strings = get_property ( ("pedal" + String (p->name_) + "Strings").to_str0 ());
+
+  if (scm_ilength (strings) < 3)
+    {
+      Music * m =       p->event_drul_[START]; 
+      if (!m) m = p->event_drul_ [STOP];
+
+      String msg = _ ("Need 3 strings for piano pedals. No pedal made. ");
+      if (m)
+	m->origin()->warning (msg);
+      else
+	warning (msg);
+      
+      return ;
+    }
+  
+  if (p->event_drul_[STOP] && p->event_drul_[START]) 
+    {
+      if (!mixed)
 	{
-	  if (!p->start_req_l_)
+	  if (!p->start_ev_)
 	    {
-	      p->req_l_drul_[STOP]->warning (_f ("can't find start of piano pedal: %s", p->name_ ));
+	      p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'",  p->name_));
 	    }
 	  else
 	    {
-	      s = get_property ("stop" + String (p->name_ ));
+	      s = ly_cadr (strings);
 	    }
-	  p->start_req_l_ = 0;
-	}
-      else if (p->req_l_drul_[START])
-	{
-	  p->start_req_l_ = p->req_l_drul_[START];
-	  s = get_property ("start" + String (p->name_ ));
+	  p->start_ev_ = p->event_drul_[START];
 	}
-
-      if (gh_string_p (s))
+    }
+  else if (p->event_drul_[STOP])
+    { 
+      if (!mixed)
 	{
-	  if (p->name_ == String ("Sustain"))
+	  if (!p->start_ev_)
 	    {
-	      // fixme: Item should be sufficient.
-	      p->item_p_ = new Text_item (get_property ("basicSustainPedalProperties"));
+	      p->event_drul_[STOP]->origin ()->warning (_f ("can't find start of piano pedal: `%s'", p->name_));
 	    }
 	  else
 	    {
-	      p->item_p_ = new Text_item (get_property ("basicPedalProperties"));
+	      s = ly_caddr (strings);
+	      if (previous_.size ())
+		previous_.pop();
 	    }
-	      p->item_p_->set_elt_property ("text", s);
-	      // guh
+	  p->start_ev_ = 0;
+	}
+    }
+  else if (p->event_drul_[START])
+    {
+      p->start_ev_ = p->event_drul_[START];
+      s = ly_car (strings);
+      if (!mixed)
+	{
+	  /*
+	    Code dup?! see below.
+	  */
+	  if (previous_.size ())
+	    // add extra space below the previous already-occuring pedal
+	    Side_position_interface::add_support (p->line_spanner_,
+						  previous_.top ());
+	  previous_.push ( p->line_spanner_);
+	}
+    }
+      
+  if (gh_string_p (s))
+    {
+      String propname = String (p->name_) + "Pedal";
 
-	  Side_position_interface si (p->item_p_);
-	  si.set_axis (Y_AXIS);
+      p->item_ = make_item (propname.to_str0 ());
+      p->item_->set_grob_property ("text", s);
+      Axis_group_interface::add_element (p->line_spanner_, p->item_);
+	  
+      announce_grob (p->item_,
+		     (p->event_drul_[START]
+		      ? p->event_drul_[START]
+		      : p->event_drul_[STOP])->self_scm ());
+    }
 
-	  // todo: init with basic props.
-	  p->item_p_->add_offset_callback (Side_position_interface::aligned_on_self, X_AXIS);
-	  p->item_p_->add_offset_callback (Side_position_interface::centered_on_parent, X_AXIS);
-	  announce_element (Score_element_info (p->item_p_,
-						p->req_l_drul_[START]
-						? p->req_l_drul_[START]
-						: p->req_l_drul_[STOP]));
-	}
+  if (!mixed)
+    {
+      p->event_drul_[START] = 0;
+      p->event_drul_[STOP] = 0;
     }
 }
 
 void
-Piano_pedal_engraver::do_pre_move_processing ()
+Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 {
-  Item * sustain = 0;
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  if (!p->bracket_ && p->event_drul_[STOP])
     {
-      if (p->name_ == String ("Sustain"))
-	sustain = p->item_p_;
+      String msg =_f ("can't find start of piano pedal bracket: `%s'", p->name_);
+      p->event_drul_[STOP]->origin ()->warning (msg);
+      p->event_drul_[STOP] =  0;
     }
 
-  for (Pedal_info*p = info_list_; p->name_; p ++)
+  if (p->event_drul_[STOP])
+    {
+      if (!p->event_drul_[START])
+	{
+	  if (previous_.size())
+	    previous_.pop();
+	}
+      
+      assert (!p->finished_bracket_); 
+
+      Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
+
+      if (!p->bracket_->get_bound (RIGHT))
+	p->bracket_->set_bound (RIGHT, cmc);
+
+      /*
+	Set properties so that the stencil-creating function will
+	know whether the right edge should be flared ___/
+       */
+
+      if (!p->event_drul_[START])
+	{
+	  SCM flare = p->bracket_->get_grob_property ("bracket-flare");
+	  p->bracket_->set_grob_property ("bracket-flare", scm_cons (gh_car (flare),
+								     gh_double2scm (0)));
+	}
+
+      p->finished_bracket_ = p->bracket_;
+      p->bracket_ = 0;
+      p->current_bracket_ev_ = 0;
+    }
+
+  if (p->event_drul_[START])
     {
-      if (p->item_p_)
+      p->start_ev_ = p->event_drul_[START];
+      p->current_bracket_ev_ = p->event_drul_[START];
+
+      p->bracket_  = make_spanner ("PianoPedalBracket");
+
+      /*
+	Set properties so that the stencil-creating function will
+	know whether the left edge should be flared \___
+      */
+
+      if (!p->finished_bracket_)
+	{
+	  SCM flare = p->bracket_->get_grob_property ("bracket-flare");
+	  p->bracket_->set_grob_property ("bracket-flare", scm_cons (gh_double2scm (0),gh_cdr (flare)));
+	}
+
+
+      /* Set this property for 'mixed style' pedals,    Ped._______/\ ,  
+        so the stencil function will shorten the ____ line by the length of the Ped. text.
+      */
+
+      if (mixed)
 	{
-	  Side_position_interface (p->item_p_).add_staff_support ();
 	  /*
-	    Hmm.
+	    Mixed style: Store a pointer to the preceding text for use in
+	    calculating the length of the line
+
+
+	    TODO:
+
+	    WTF is pedal-text not the bound of the object? --hwn
 	  */
-	  if (p->name_ != String ("Sustain"))
-	    {
-	      if (sustain)
-		{
-		  Side_position_interface st (p->item_p_);
-		  st.add_support (sustain);
-		}
-	    }
-	  typeset_element (p->item_p_);
+	  if (p->item_)
+	    p->bracket_->set_grob_property ("pedal-text", p->item_->self_scm ());
+	}
+
+
+      /*
+	We do not use currentMusicalColumn for the left span-point.
+	If the column as accidentals (eg on a different stave), the
+	currentMusicalColumn is too wide, making the bracket too big.
+
+	TODO:
+
+	Hmm. What do we do when there are no notes when the spanner starts?
+
+	TODO:
+
+	what about the right span point?
+	
+       */
+      Axis_group_interface::add_element (p->line_spanner_, p->bracket_);	      
+      announce_grob (p->bracket_, p->event_drul_[START]->self_scm ());
+
+      if (!p->event_drul_[STOP])
+	{
+
+	  /*
+	    code dup. --hwn.
+
+	    // position new pedal spanner below the current one
+	  */
+	  if (previous_.size()) 
+	    Side_position_interface::add_support (p->line_spanner_, previous_.top());
+
+	  previous_.push (p->line_spanner_);	
+	}
+    }
+
+  p->event_drul_[START] = 0;
+  p->event_drul_[STOP] = 0;
+}
+
+void
+Piano_pedal_engraver::finalize ()
+{  
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+    {
+      /*
+	suicide?
+       */
+      if (p->line_spanner_
+	  && !p->line_spanner_->live())
+	p->line_spanner_ = 0;
+      
+      if (p->line_spanner_)
+	{
+	  p->finished_line_spanner_ = p->line_spanner_;
+	  typeset_all ();
+	}
+      if (p->bracket_
+	  && !p->bracket_->live())
+	p->bracket_ = 0;
+      
+      if (p->bracket_)
+	{
+	  p->current_bracket_ev_->origin ()->warning (_ ("unterminated pedal bracket"));
+	  p->bracket_->suicide ();
+	  p->bracket_ = 0;
 	}
-      p->item_p_ = 0;
     }
 }
 
+  
 void
-Piano_pedal_engraver::do_post_move_processing ()
+Piano_pedal_engraver::stop_translation_timestep ()
 {
+  for (Pedal_info*p = info_list_; p && p->name_; p ++)
+    {
+      if (!p->bracket_)
+	{
+	  p->finished_line_spanner_ = p->line_spanner_;
+	  p->line_spanner_ = 0;
+	}
+    }
+  
+  typeset_all ();
+
   for (Pedal_info*p = info_list_; p->name_; p ++)
     {
-      p->req_l_drul_[STOP] = 0;
-      p->req_l_drul_[START] = 0;
+      p->event_drul_[STOP] = 0;
+      p->event_drul_[START] = 0;
+    }
+}
+
+
+void
+Piano_pedal_engraver::typeset_all ()
+{
+  Item * sustain = 0;
+  for (Pedal_info*p = info_list_; p->name_; p ++)
+    {
+      /*
+	Handle suicide. 
+       */
+      if (p->finished_line_spanner_
+	  && !p->finished_line_spanner_->live ())
+	p->finished_line_spanner_ = 0;
+      if (p->finished_bracket_
+	  && !p->finished_bracket_->live())
+	p->finished_bracket_ = 0;
+
+
+      if (p->name_ == String ("Sustain"))
+	sustain = p->item_;
+
+      if (p->item_)
+	{
+	  /*
+	    Hmm.
+	  */
+	  if (p->name_ != String ("Sustain") && sustain)
+	    {
+	      Side_position_interface::add_support (p->item_,sustain);
+	    }
+	  typeset_grob (p->item_);
+	  p->item_ = 0;
+	}
+      
+      if (p->finished_bracket_)
+	{
+	  Grob * r = p->finished_bracket_->get_bound (RIGHT);      
+	  if (!r)
+	    {
+	      p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
+	    }
+
+	  typeset_grob (p->finished_bracket_);
+	  
+	  p->finished_bracket_ =0;
+	}
+
+      if (p->finished_line_spanner_)
+	{
+	  Grob * l = p->finished_line_spanner_->get_bound (LEFT);
+	  Grob * r = p->finished_line_spanner_->get_bound (RIGHT);      
+	  if (!r && l)
+	    p->finished_line_spanner_->set_bound (RIGHT, l);
+	  else if (!l && r)
+	    p->finished_line_spanner_->set_bound (LEFT, r);
+	  else if (!r && !l)
+	    {
+	      Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
+	      Item * ci = dynamic_cast<Item*> (cc);
+	      p->finished_line_spanner_->set_bound (RIGHT, ci);
+	      p->finished_line_spanner_->set_bound (LEFT, ci);	  
+	    }
+	  typeset_grob (p->finished_line_spanner_);
+	  p->finished_line_spanner_ = 0;
+	}
     }
 }
+
+ENTER_DESCRIPTION (Piano_pedal_engraver,
+/* descr */       "Engrave piano pedal symbols and brackets.",
+/* creats*/       "SostenutoPedal SustainPedal UnaCordaPedal SostenutoPedalLineSpanner SustainPedalLineSpanner UnaCordaPedalLineSpanner",
+/* accepts */     "pedal-event",
+/* acks  */       "note-column-interface",
+/* reads */       "pedalSostenutoStrings pedalSustainStrings pedalUnaCordaStrings pedalSostenutoStyle pedalSustainStyle pedalUnaCordaStyle",
+/* write */       "");