]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/completion-note-heads-engraver.cc
apply Julian's patch to fix install-info warnings
[lilypond.git] / lily / completion-note-heads-engraver.cc
index 11b0e185fefe02c51c3ae518e5f29d70c4f476c4..a2c606f472897c58c6c17d221aa806902114a9dc 100644 (file)
@@ -1,27 +1,42 @@
 /*
-  completion-note-heads-engraver.cc -- Completion_heads_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2011 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
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include <cctype>
+using namespace std;
 
-#include "rhythmic-head.hh"
-#include "output-def.hh"
-#include "event.hh"
-#include "dots.hh"
 #include "dot-column.hh"
-#include "staff-symbol-referencer.hh"
+#include "dots.hh"
+#include "duration.hh"
+#include "global-context.hh"
 #include "item.hh"
+#include "output-def.hh"
+#include "pitch.hh"
+#include "rhythmic-head.hh"
 #include "score-engraver.hh"
-#include "warn.hh"
 #include "spanner.hh"
+#include "staff-symbol-referencer.hh"
+#include "stream-event.hh"
 #include "tie.hh"
-#include "global-context.hh"
+#include "tie-column.hh"
+#include "warn.hh"
 
-/*
-  TODO: make matching rest engraver.
-*/
+#include "translator.icc"
 
 /*
   How does this work?
   longer than what's specified, than what is left to do and it should
   not cross barlines.
 
-  We copy the reqs into scratch note reqs, to make sure that we get
+  We copy the events into scratch note events, to make sure that we get
   all durations exactly right.
 */
 
 class Completion_heads_engraver : public Engraver
 {
-  Link_array<Item> notes_;
-  Link_array<Item> prev_notes_;
-  Link_array<Grob> ties_;
-
-  Link_array<Item> dots_;
-  Link_array<Music> note_reqs_;
-  Link_array<Music> scratch_note_reqs_;
-
+  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_;
+  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 ();
-  Duration find_nearest_duration (Rational length);
+  Item *make_note_head (Stream_event *);
 
 public:
   TRANSLATOR_DECLARATIONS (Completion_heads_engraver);
 
 protected:
   virtual void initialize ();
-  virtual void start_translation_timestep ();
-  virtual bool try_music (Music *req);
-  virtual void process_music ();
-  virtual void stop_translation_timestep ();
+  void make_tie (Grob *, Grob *);
+  void start_translation_timestep ();
+  void process_music ();
+  void stop_translation_timestep ();
+  DECLARE_TRANSLATOR_LISTENER (note);
 };
 
 void
@@ -73,85 +90,50 @@ Completion_heads_engraver::initialize ()
   is_first_ = false;
 }
 
-bool
-Completion_heads_engraver::try_music (Music *m)
+IMPLEMENT_TRANSLATOR_LISTENER (Completion_heads_engraver, note);
+void
+Completion_heads_engraver::listen_note (Stream_event *ev)
 {
-  if (m->is_mus_type ("note-event"))
-    {
-      note_reqs_.push (m);
-
-      is_first_ = true;
-      Moment musiclen = m->get_length ();
-      Moment now = now_mom ();
+  note_events_.push_back (ev);
 
-      if (now_mom ().grace_part_)
-       {
-         musiclen.grace_part_ = musiclen.main_part_;
-         musiclen.main_part_ = Rational (0, 1);
-       }
-      note_end_mom_ = note_end_mom_ >? (now + musiclen);
-      do_nothing_until_ = Rational (0, 0);
-
-      return true;
-    }
-  else if (m->is_mus_type ("busy-playing-event"))
-    {
-      return note_reqs_.size () && is_first_;
-    }
+  is_first_ = true;
+  Moment now = now_mom ();
+  Moment musiclen = get_event_length (ev, now);
 
-  return false;
+  note_end_mom_ = max (note_end_mom_, (now + musiclen));
+  do_nothing_until_ = Rational (0, 0);
 }
 
 /*
-  The duration _until_ the next barline.
+  The duration _until_ the next bar line.
 */
 Moment
 Completion_heads_engraver::next_barline_moment ()
 {
   Moment *e = unsmob_moment (get_property ("measurePosition"));
   Moment *l = unsmob_moment (get_property ("measureLength"));
-  if (!e || !l)
+  if (!e || !l || !to_boolean (get_property ("timing")))
     {
-      programming_error ("No timing props set?");
-      return Moment (1, 1);
+      return Moment (0, 0);
     }
 
   return (*l - *e);
 }
 
-Duration
-Completion_heads_engraver::find_nearest_duration (Rational length)
+Item *
+Completion_heads_engraver::make_note_head (Stream_event *ev)
 {
-  int log_limit = 6;
-
-  Duration d (0, 0);
-
-  /*
-    this could surely be done more efficient. Left to the reader as an
-    excercise.  */
-  while (d.get_length () > length && d.duration_log () < log_limit)
-    {
-      if (d.dot_count ())
-       {
-         d = Duration (d.duration_log (), d.dot_count ()- 1);
-         continue;
-       }
-      else
-       {
-         d = Duration (d.duration_log () + 1, 2);
-       }
-    }
+  Item *note = make_item ("NoteHead", ev->self_scm ());
+  Pitch *pit = unsmob_pitch (ev->get_property ("pitch"));
 
-  if (d.duration_log () >= log_limit)
-    {
-      // junk the dots.
-      d = Duration (d.duration_log (), 0);
+  int pos = pit->steps ();
+  SCM c0 = get_property ("middleCPosition");
+  if (scm_is_number (c0))
+    pos += scm_to_int (c0);
 
-      // scale up.
-      d = d.compressed (length / d.get_length ());
-    }
+  note->set_property ("staff-position", scm_from_int (pos));
 
-  return d;
+  return note;
 }
 
 void
@@ -170,127 +152,103 @@ Completion_heads_engraver::process_music ()
   Duration *orig = 0;
   if (left_to_do_)
     {
-      note_dur = find_nearest_duration (left_to_do_);
+      /*
+       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_);
     }
   else
     {
-      orig = unsmob_duration (note_reqs_[0]->get_property ("duration"));
+      orig = unsmob_duration (note_events_[0]->get_property ("duration"));
       note_dur = *orig;
+      factor_ = note_dur.factor ();
+      left_to_do_ = orig->get_length ();
     }
   Moment nb = next_barline_moment ();
-  if (nb < note_dur.get_length ())
+  if (nb.main_part_ && nb < note_dur.get_length ())
     {
-      note_dur = find_nearest_duration (nb.main_part_);
-
-      Moment next = now;
-      next.main_part_ += note_dur.get_length ();
-
-      get_global_context ()->add_moment_to_process (next);
-      do_nothing_until_ = next.main_part_;
+      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_);
     }
 
-  if (orig)
-    {
-      left_to_do_ = orig->get_length ();
-    }
+  do_nothing_until_ = now.main_part_ + note_dur.get_length ();
 
-  if (orig && note_dur.get_length () != orig->get_length ())
+  for (vsize i = 0; left_to_do_ && i < note_events_.size (); i++)
     {
-      if (!scratch_note_reqs_.size ())
-       for (int i = 0; i < note_reqs_.size (); i++)
-         {
-           Music *m = note_reqs_[i]->clone ();
-           scratch_note_reqs_.push (m);
-         }
+      bool need_clone = !orig || *orig != note_dur;
+      Stream_event *event = note_events_[i];
+
+      if (need_clone)
+       event = event->clone ();
+
+      SCM pits = note_events_[i]->get_property ("pitch");
+      event->set_property ("pitch", pits);
+      event->set_property ("duration", note_dur.smobbed_copy ());
+      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 ();
+      notes_.push_back (note);
     }
 
-  for (int i = 0;
-       left_to_do_ && i < note_reqs_.size (); i++)
+  if (prev_notes_.size () == notes_.size ())
     {
-      Music *req = note_reqs_[i];
-      if (scratch_note_reqs_.size ())
-       {
-         req = scratch_note_reqs_[i];
-         SCM pits = note_reqs_[i]->get_property ("pitch");
-         req->set_property ("pitch", pits);
-       }
-
-      req->set_property ("duration", note_dur.smobbed_copy ());
-
-      Item *note = make_item ("NoteHead", req->self_scm ());
-      note->set_property ("duration-log",
-                         scm_int2num (note_dur.duration_log ()));
-
-      int dots = note_dur.dot_count ();
-      if (dots)
-       {
-         Item *d = make_item ("Dots", SCM_EOL);
-         Rhythmic_head::set_dots (note, d);
-
-         /*
-           measly attempt to save an eeny-weenie bit of memory.
-         */
-         if (dots != scm_to_int (d->get_property ("dot-count")))
-           d->set_property ("dot-count", scm_int2num (dots));
-
-         d->set_parent (note, Y_AXIS);
-         dots_.push (d);
-       }
-
-      Pitch *pit = unsmob_pitch (req->get_property ("pitch"));
-
-      int pos = pit->steps ();
-      SCM c0 = get_property ("middleCPosition");
-      if (scm_is_number (c0))
-       pos += scm_to_int (c0);
-
-      note->set_property ("staff-position", scm_int2num (pos));
-      notes_.push (note);
+      for (vsize i = 0; i < notes_.size (); i++)
+       make_tie (prev_notes_[i], notes_[i]);
     }
 
-  if (prev_notes_.size () == notes_.size ())
-    {
-      for (int i = 0; i < notes_.size (); i++)
-       {
-         Grob *p = make_spanner ("Tie", SCM_EOL);
-         Tie::set_interface (p); // cannot remove yet!
+  if (ties_.size () && !tie_column_)
+    tie_column_ = make_spanner ("TieColumn", ties_[0]->self_scm ());
 
-         Tie::set_head (p, LEFT, prev_notes_[i]);
-         Tie::set_head (p, RIGHT, notes_[i]);
-
-         ties_.push (p);
-       }
-    }
+  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 ());
   /*
     don't do complicated arithmetic with grace notes.
   */
-  if (orig
-      && now_mom ().grace_part_)
-    {
-      left_to_do_ = Rational (0, 0);
-    }
+  if (orig && now_mom ().grace_part_)
+    left_to_do_ = Rational (0, 0);
+}
+
+void
+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);
+  ties_.push_back (p);
 }
 
 void
 Completion_heads_engraver::stop_translation_timestep ()
 {
   ties_.clear ();
+  tie_column_ = 0;
 
   if (notes_.size ())
     prev_notes_ = notes_;
   notes_.clear ();
-
-  dots_.clear ();
-
-  for (int i = scratch_note_reqs_.size (); i--;)
-    {
-      scm_gc_unprotect_object (scratch_note_reqs_[i]->self_scm ());
-    }
-
-  scratch_note_reqs_.clear ();
 }
 
 void
@@ -299,21 +257,38 @@ Completion_heads_engraver::start_translation_timestep ()
   Moment now = now_mom ();
   if (note_end_mom_.main_part_ <= now.main_part_)
     {
-      note_reqs_.clear ();
+      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 ()));
 }
 
 Completion_heads_engraver::Completion_heads_engraver ()
 {
+  tie_column_ = 0;
 }
 
 ADD_TRANSLATOR (Completion_heads_engraver,
-               /* descr */ "This engraver replaces "
-               "@code{Note_heads_engraver}. It plays some trickery to "
-               "break long notes and automatically tie them into the next measure.",
-               /* creats*/ "NoteHead Dots Tie",
-               /* accepts */ "busy-playing-event note-event",
-               /* acks  */ "",
-               /* reads */ "middleCPosition measurePosition measureLength",
-               /* write */ "");
+               /* 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 */
+               "measureLength "
+               "measurePosition "
+               "middleCPosition "
+               "timing ",
+
+               /* write */
+               "completionBusy "
+               );