]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/completion-note-heads-engraver.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / completion-note-heads-engraver.cc
index 2534f6992b126d9926d806a7b11513fdbc8b3aa2..5775ef188a17e8bbd2cd3ab45c001115a1782d77 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -27,34 +27,18 @@ using namespace std;
 #include "item.hh"
 #include "output-def.hh"
 #include "pitch.hh"
-#include "pqueue.hh"
 #include "rhythmic-head.hh"
 #include "score-engraver.hh"
 #include "spanner.hh"
 #include "staff-symbol-referencer.hh"
 #include "stream-event.hh"
 #include "tie.hh"
+#include "tie-column.hh"
 #include "warn.hh"
+#include "misc.hh"
 
 #include "translator.icc"
 
-/*
-  TODO: make matching rest engraver.
-*/
-struct Pending_tie
-{
-  Moment when_;
-  Stream_event* tie_event_;
-  Pending_tie () : tie_event_ (0) {}
-};
-
-static int
-compare (Pending_tie const &a, Pending_tie const &b)
-{
-  return compare (a.when_, b.when_);
-}
-
-
 /*
   How does this work?
 
@@ -64,7 +48,7 @@ compare (Pending_tie const &a, Pending_tie const &b)
   Every time process_music () is called and there are note events, we
   figure out how long the note to typeset should be. It should be no
   longer than what's specified, than what is left to do and it should
-  not cross barlines.
+  not cross barlines or sub-bar units.
 
   We copy the events into scratch note events, to make sure that we get
   all durations exactly right.
@@ -72,23 +56,20 @@ compare (Pending_tie const &a, Pending_tie const &b)
 
 class Completion_heads_engraver : public Engraver
 {
-  vector<Item*> notes_;
-  vector<Item*> prev_notes_;
+  vector<Item *> notes_;
+  vector<Item *> prev_notes_;
   // Must remember notes for explicit ties.
-  vector<Item*> tie_note_candidates_;
-  vector<Stream_event*> tie_note_candidate_events_;
-  vector<Grob*> ties_;
-  PQueue<Pending_tie> pending_ties_;
-  vector<Stream_event*> note_events_;
-  Stream_event *current_tie_event_;
+  vector<Grob *> ties_;
+  vector<Stream_event *> note_events_;
+  Spanner *tie_column_;
   Moment note_end_mom_;
   bool is_first_;
   Rational left_to_do_;
   Rational do_nothing_until_;
   Rational factor_;
 
-  Moment next_barline_moment ();
-  Item *make_note_head (Stream_event*);
+  Moment next_moment (Rational const &);
+  Item *make_note_head (Stream_event *);
 
 public:
   TRANSLATOR_DECLARATIONS (Completion_heads_engraver);
@@ -100,14 +81,12 @@ protected:
   void process_music ();
   void stop_translation_timestep ();
   DECLARE_TRANSLATOR_LISTENER (note);
-  DECLARE_TRANSLATOR_LISTENER (tie);
 };
 
 void
 Completion_heads_engraver::initialize ()
 {
   is_first_ = false;
-  current_tie_event_ = 0;
 }
 
 IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, note);
@@ -115,7 +94,7 @@ void
 Completion_heads_engraver::listen_note (Stream_event *ev)
 {
   note_events_.push_back (ev);
-  
+
   is_first_ = true;
   Moment now = now_mom ();
   Moment musiclen = get_event_length (ev, now);
@@ -124,19 +103,11 @@ Completion_heads_engraver::listen_note (Stream_event *ev)
   do_nothing_until_ = Rational (0, 0);
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, tie);
-void
-Completion_heads_engraver::listen_tie (Stream_event *ev)
-{
-  is_first_ = true;
-  current_tie_event_ = ev;
-}
-
 /*
-  The duration _until_ the next barline.
+  The duration _until_ the next bar line or completion unit
 */
 Moment
-Completion_heads_engraver::next_barline_moment ()
+Completion_heads_engraver::next_moment (Rational const &note_len)
 {
   Moment *e = unsmob_moment (get_property ("measurePosition"));
   Moment *l = unsmob_moment (get_property ("measureLength"));
@@ -145,10 +116,43 @@ Completion_heads_engraver::next_barline_moment ()
       return Moment (0, 0);
     }
 
-  return (*l - *e);
+  Moment result = *l - *e;
+  Moment const *unit = unsmob_moment (get_property ("completionUnit"));
+
+  if (unit)
+    {
+      Rational const now_unit = e->main_part_ / unit->main_part_;
+      if (now_unit.den () > 1)
+        {
+          /*
+            within a unit - go to the end of that
+          */
+          result = unit->main_part_
+                   * (Rational (1) - (now_unit - now_unit.trunc_rat ()));
+        }
+      else
+        {
+          /*
+            at the beginning of a unit:
+            take a power-of-two number of units, but not more than required,
+            since then the Duration constructor destroys the unit structure
+          */
+          if (note_len < result.main_part_)
+            result.main_part_ = note_len;
+          Rational const step_unit = result.main_part_ / unit->main_part_;
+          if (step_unit.den () < step_unit.num ())
+            {
+              int const log2
+                = intlog2 (int (step_unit.num () / step_unit.den ()));
+              result.main_part_ = unit->main_part_ * Rational (1 << log2);
+            }
+        }
+    }
+
+  return result;
 }
 
-Item*
+Item *
 Completion_heads_engraver::make_note_head (Stream_event *ev)
 {
   Item *note = make_item ("NoteHead", ev->self_scm ());
@@ -170,14 +174,6 @@ Completion_heads_engraver::process_music ()
   if (!is_first_ && !left_to_do_)
     return;
 
-  if (current_tie_event_)
-    {
-      Pending_tie pending;
-      pending.when_ = note_end_mom_;
-      pending.tie_event_ = current_tie_event_;
-      pending_ties_.insert (pending);
-    }
-  
   is_first_ = false;
 
   Moment now = now_mom ();
@@ -189,28 +185,27 @@ Completion_heads_engraver::process_music ()
   if (left_to_do_)
     {
       /*
-       note that note_dur may be strictly less than left_to_do_
-       (say, if left_to_do_ == 5/8)
+        note that note_dur may be strictly less than left_to_do_
+        (say, if left_to_do_ == 5/8)
       */
-      if (factor_.denominator () == 1 && factor_ > Rational (1, 1))
-       note_dur = Duration (left_to_do_, false);
-      else
-       note_dur = Duration (left_to_do_ / factor_, false).compressed (factor_);
+      note_dur = Duration (left_to_do_ / factor_, false).compressed (factor_);
     }
   else
     {
       orig = unsmob_duration (note_events_[0]->get_property ("duration"));
       note_dur = *orig;
-      factor_ = note_dur.factor ();
+      SCM factor = get_property ("completionFactor");
+      if (ly_is_procedure (factor))
+        factor = scm_call_2 (factor,
+                             context ()->self_scm (),
+                             note_dur.smobbed_copy ());
+      factor_ = robust_scm2rational (factor, note_dur.factor ());
       left_to_do_ = orig->get_length ();
     }
-  Moment nb = next_barline_moment ();
+  Moment nb = next_moment (note_dur.get_length ());
   if (nb.main_part_ && nb < note_dur.get_length ())
     {
-      if (factor_.denominator () == 1 && factor_ > Rational (1, 1))
-       note_dur = Duration (nb.main_part_, false);
-      else
-       note_dur = Duration (nb.main_part_ / factor_, false).compressed (factor_);
+      note_dur = Duration (nb.main_part_ / factor_, false).compressed (factor_);
     }
 
   do_nothing_until_ = now.main_part_ + note_dur.get_length ();
@@ -221,7 +216,7 @@ Completion_heads_engraver::process_music ()
       Stream_event *event = note_events_[i];
 
       if (need_clone)
-       event = event->clone ();
+        event = event->clone ();
 
       SCM pits = note_events_[i]->get_property ("pitch");
       event->set_property ("pitch", pits);
@@ -229,35 +224,37 @@ Completion_heads_engraver::process_music ()
       event->set_property ("length", Moment (note_dur.get_length ()).smobbed_copy ());
       event->set_property ("duration-log", scm_from_int (note_dur.duration_log ()));
 
+      /*
+        The Completion_heads_engraver splits an event into a group of consecutive events.
+        For each event in the group, the property "autosplit-end" denotes whether the current event
+        was truncated during splitting. Based on "autosplit-end", the Tie_engraver decides whether a
+        tie event should be processed.
+      */
+      event->set_property ("autosplit-end",
+                           ly_bool2scm (left_to_do_ - note_dur.get_length () > Rational (0)));
+
       Item *note = make_note_head (event);
       if (need_clone)
-       event->unprotect ();
+        event->unprotect ();
       notes_.push_back (note);
     }
-  
-  if (pending_ties_.size ()
-      && pending_ties_.front().when_ == now_mom())
-    {
-      for (vsize i = 0; i < tie_note_candidate_events_.size(); i++)
-       for (vsize j = 0; j < note_events_.size(); j++)
-         {
-           Pitch *p =  unsmob_pitch (note_events_[j]->get_property ("pitch"));
-           Pitch *p_last
-             = unsmob_pitch (tie_note_candidate_events_[i]->get_property ("pitch"));
-           if (p && p_last && *p == *p_last)
-             make_tie (tie_note_candidates_[i], notes_[j]);
-         }
-    }
-      
+
   if (prev_notes_.size () == notes_.size ())
     {
       for (vsize i = 0; i < notes_.size (); i++)
-       make_tie (prev_notes_[i], notes_[i]);
+        make_tie (prev_notes_[i], notes_[i]);
     }
 
+  if (ties_.size () && !tie_column_)
+    tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
+
+  if (tie_column_)
+    for (vsize i = ties_.size (); i--;)
+      Tie_column::add_tie (tie_column_, ties_[i]);
+
   left_to_do_ -= note_dur.get_length ();
   if (left_to_do_)
-    get_global_context ()->add_moment_to_process (now.main_part_ + note_dur.get_length());
+    get_global_context ()->add_moment_to_process (now.main_part_ + note_dur.get_length ());
   /*
     don't do complicated arithmetic with grace notes.
   */
@@ -271,13 +268,15 @@ Completion_heads_engraver::make_tie (Grob *left, Grob *right)
   Grob *p = make_spanner ("Tie", SCM_EOL);
   Tie::set_head (p, LEFT, left);
   Tie::set_head (p, RIGHT, right);
+  announce_end_grob (p, SCM_EOL);
   ties_.push_back (p);
 }
-                                    
+
 void
 Completion_heads_engraver::stop_translation_timestep ()
 {
   ties_.clear ();
+  tie_column_ = 0;
 
   if (notes_.size ())
     prev_notes_ = notes_;
@@ -288,42 +287,39 @@ void
 Completion_heads_engraver::start_translation_timestep ()
 {
   Moment now = now_mom ();
-  while (pending_ties_.size() && pending_ties_.front().when_ < now)
-    {
-      pending_ties_.delmin();
-    }
-  current_tie_event_ = 0;
   if (note_end_mom_.main_part_ <= now.main_part_)
     {
-      tie_note_candidate_events_ = note_events_;
-      tie_note_candidates_ = prev_notes_;
-
       note_events_.clear ();
       prev_notes_.clear ();
     }
   context ()->set_property ("completionBusy",
-                           ly_bool2scm (note_events_.size ()));
+                            ly_bool2scm (note_events_.size ()));
 }
 
 Completion_heads_engraver::Completion_heads_engraver ()
 {
+  tie_column_ = 0;
 }
 
 ADD_TRANSLATOR (Completion_heads_engraver,
-               /* doc */
-               "This engraver replaces @code{Note_heads_engraver}.  It plays"
-               " some trickery to break long notes and automatically tie them"
-               " into the next measure."
-               ,
-               /* create */
-               "NoteHead "
-               "Tie "
-               ,
-               /* read */
-               "middleCPosition "
-               "measurePosition "
-               "measureLength "
-               ,
-               /* write */
-               "completionBusy "
-               );
+                /* doc */
+                "This engraver replaces @code{Note_heads_engraver}.  It plays"
+                " some trickery to break long notes and automatically tie them"
+                " into the next measure.",
+
+                /* create */
+                "NoteHead "
+                "Tie "
+                "TieColumn ",
+
+                /* read */
+                "completionFactor "
+                "completionUnit "
+                "measureLength "
+                "measurePosition "
+                "middleCPosition "
+                "timing ",
+
+                /* write */
+                "completionBusy "
+               );