]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/timing-translator.cc
Doc-es: various updates.
[lilypond.git] / lily / timing-translator.cc
index 447d08a5c29bbb7e3d1ef7b0a9a1073e57f0ebb3..67c2ffeed1a34fded9052512ed206bac5abb53c8 100644 (file)
@@ -1,10 +1,20 @@
 /*
-  timing-translator.cc -- implement Timing_translator
+  This file is part of LilyPond, the GNU music typesetter.
 
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  source file of the GNU LilyPond music typesetter
+  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.
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  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 "timing-translator.hh"
@@ -12,7 +22,8 @@
 #include "warn.hh"
 #include "translator-group.hh"
 #include "global-context.hh"
-#include "multi-measure-rest.hh"
+#include "moment.hh"
+#include "lily-imports.hh"
 
 void
 Timing_translator::stop_translation_timestep ()
@@ -25,45 +36,117 @@ Timing_translator::stop_translation_timestep ()
       Moment barleft = (measure_length () - measure_position (context ()));
       Moment now = now_mom ();
 
-      if (barleft > Moment (0)
-         /*
-           Hmm. We insert the bar moment every time we process a
-           moment.  A waste of cpu?
-         */
-         && !now.grace_part_)
-       global->add_moment_to_process (now + barleft);
+      if (barleft > Moment (0))
+        {
+          Moment nextmom = now + barleft;
+          nextmom.grace_part_ = Rational (0);
+          global->add_moment_to_process (nextmom);
+        }
     }
 }
 
 void
 Timing_translator::initialize ()
 {
-  context ()->add_alias (ly_symbol2scm ("Timing"));
-  context ()->set_property ("currentBarNumber", scm_from_int (1));
+  Context *timing = unsmob<Context>
+    (Lily::ly_context_find (context ()->self_scm (), ly_symbol2scm ("Timing")));
+  if (timing != context ())
+    {
+      context ()->add_alias (ly_symbol2scm ("Timing"));
+
+      if (!timing)
+        {
+          programming_error ("Can't find Timing context template");
+          timing = context ();
+        }
+    }
+
+  SCM barnumber = timing->get_property ("currentBarNumber");
+  if (!scm_is_integer (barnumber))
+    barnumber = scm_from_int (1);
+  context ()->set_property ("currentBarNumber", barnumber);
+  context ()->set_property ("internalBarNumber", barnumber);
+
+  SCM timeSignatureFraction = timing->get_property ("timeSignatureFraction");
+
+  if (!scm_is_pair (timeSignatureFraction))
+    {
+      programming_error ("missing timeSignatureFraction");
+      timeSignatureFraction = scm_cons (scm_from_int (4), scm_from_int (4));
+    }
+  context ()->set_property ("timeSignatureFraction", timeSignatureFraction);
+
+  SCM measureLength = timing->get_property ("measureLength");
+
+  if (!unsmob<Moment> (measureLength))
+    {
+      measureLength =
+        Moment (ly_scm2rational
+                (scm_divide (scm_car (timeSignatureFraction),
+                             scm_cdr (timeSignatureFraction)))).smobbed_copy ();
+    }
+  context ()->set_property ("measureLength", measureLength);
 
-  context ()->set_property ("timeSignatureFraction",
-                           scm_cons (scm_from_int (4), scm_from_int (4)));
   /*
     Do not init measurePosition; this should be done from global
     context.
   */
-  context ()->set_property ("measureLength",
-                           Moment (Rational (1)).smobbed_copy ());
-  context ()->set_property ("beatLength",
-                           Moment (Rational (1, 4)).smobbed_copy ());
+
+  SCM timeSignatureSettings = timing->get_property ("timeSignatureSettings");
+  if (!scm_is_pair (timeSignatureSettings))
+    {
+      programming_error ("missing timeSignatureSettings");
+      timeSignatureSettings = Lily::default_time_signature_settings;
+    }
+  context ()->set_property ("timeSignatureSettings", timeSignatureSettings);
+
+  SCM beamExceptions = timing->get_property ("beamExceptions");
+  if (!scm_is_pair (beamExceptions))
+    {
+      beamExceptions = Lily::beam_exceptions (timeSignatureFraction,
+                                              timeSignatureSettings);
+    }
+  context ()->set_property ("beamExceptions", beamExceptions);
+
+  SCM baseMoment = timing->get_property ("baseMoment");
+  if (!unsmob<Moment> (baseMoment))
+    {
+      baseMoment =
+        Moment (ly_scm2rational
+                (Lily::base_length (timeSignatureFraction,
+                                    timeSignatureSettings))).smobbed_copy ();
+    }
+  context ()->set_property ("baseMoment", baseMoment);
+
+  SCM beatStructure = timing->get_property ("beatStructure");
+  if (!scm_is_pair (beatStructure))
+    {
+      beatStructure =
+        Lily::beat_structure (ly_rational2scm (unsmob<Moment> (baseMoment)->main_part_),
+                              timeSignatureFraction,
+                              timeSignatureSettings);
+    }
+  context ()->set_property ("beatStructure", beatStructure);
+
+  context ()->set_property ("beamHalfMeasure",
+                            timing->get_property ("beamHalfMeasure"));
+
+  context ()->set_property ("autoBeaming",
+                            timing->get_property ("autoBeaming"));
 }
 
 Rational
 Timing_translator::measure_length () const
 {
   SCM l = get_property ("measureLength");
-  if (unsmob_moment (l))
-    return unsmob_moment (l)->main_part_;
+  if (unsmob<Moment> (l))
+    return unsmob<Moment> (l)->main_part_;
   else
     return Rational (1);
 }
 
-Timing_translator::Timing_translator ()
+Timing_translator::Timing_translator (Context *c)
+  : Translator (c)
 {
 }
 
@@ -91,45 +174,86 @@ Timing_translator::start_translation_timestep ()
   Moment measposp;
 
   SCM s = get_property ("measurePosition");
-  if (unsmob_moment (s))
-    measposp = *unsmob_moment (s);
+  if (unsmob<Moment> (s))
+    measposp = *unsmob<Moment> (s);
   else
     {
       measposp = now;
-      context ()->set_property ("measurePosition",
-                               measposp.smobbed_copy ());
     }
 
-  measposp += dt;
-
-  SCM barn = get_property ("currentBarNumber");
-  int b = 0;
-  if (scm_is_number (barn))
-    b = scm_to_int (barn);
+  int current_barnumber = robust_scm2int (get_property ("currentBarNumber"), 0);
+  int internal_barnumber = robust_scm2int (get_property ("internalBarNumber"), 0);
 
   SCM cad = get_property ("timing");
   bool c = to_boolean (cad);
 
-  Rational len = measure_length ();
-  while (c && measposp.main_part_ >= len)
+  if (c)
     {
-      measposp.main_part_ -= len;
-      b++;
+      Rational len = measure_length ();
+
+      measposp += dt;
+
+      while (measposp.main_part_ >= len)
+        {
+          measposp.main_part_ -= len;
+          current_barnumber++;
+          internal_barnumber++;
+        }
     }
 
-  context ()->set_property ("currentBarNumber", scm_from_int (b));
+
+  // Because "timing" can be switched on and off asynchronously with
+  // graces, measurePosition might get into strange settings of
+  // grace_part_.  It does not actually make sense to have it diverge
+  // from the main timing.  Updating the grace part outside of the
+  // actual check for "timing" looks strange and will lead to changes
+  // of grace_part_ even when timing is off.  However, when timing is
+  // switched back on again, this will generally happen in an override
+  // that does _not_ in itself advance current_moment.  So the whole
+  // timing advance logic will only get triggered while "timing" is
+  // still of.  Maybe we should keep measurePosition.grace_part_
+  // constantly at zero anyway?
+
+  measposp.grace_part_ = now.grace_part_;
+
+
+  context ()->set_property ("currentBarNumber", scm_from_int (current_barnumber));
+  context ()->set_property ("internalBarNumber", scm_from_int (internal_barnumber));
   context ()->set_property ("measurePosition", measposp.smobbed_copy ());
 }
 
 #include "translator.icc"
 
+void
+Timing_translator::boot ()
+{
+
+}
+
 ADD_TRANSLATOR (Timing_translator,
-               "This engraver adds the alias "
-               "@code{Timing} to its containing context."
-               "Responsible for synchronizing timing information from staves.  "
-               "Normally in @code{Score}.  In order to create polyrhythmic music, "
-               "this engraver should be removed from @code{Score} and placed in "
-               "@code{Staff}. "
-               "\n\nThis engraver adds the alias @code{Timing} to its containing context.",
-
-               "", "", "", "");
+                /* doc */
+                "This engraver adds the alias @code{Timing} to its containing"
+                " context.  Responsible for synchronizing timing information"
+                " from staves.  Normally in @code{Score}.  In order to create"
+                " polyrhythmic music, this engraver should be removed from"
+                " @code{Score} and placed in @code{Staff}.",
+
+                /* create */
+                "",
+
+                /* read */
+                "baseMoment "
+                "currentBarNumber "
+                "internalBarNumber "
+                "measureLength "
+                "measurePosition "
+                "timeSignatureFraction ",
+
+                /* write */
+                "baseMoment "
+                "currentBarNumber "
+                "internalBarNumber "
+                "measureLength "
+                "measurePosition "
+                "timeSignatureFraction "
+               );