]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/multi-measure-rest.cc
Web-ja: update introduction
[lilypond.git] / lily / multi-measure-rest.cc
index 42078d9b40f75996b7013b99ea53e9d0043de52d..38dd598ee95d329be323342eeddb4da4817b946b 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
+  Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
 
 #include "multi-measure-rest.hh"
 
-#include "warn.hh"
+#include "directional-element-interface.hh"
+#include "font-interface.hh"
+#include "international.hh"
+#include "lookup.hh"
+#include "misc.hh"
+#include "moment.hh"
 #include "output-def.hh"
 #include "paper-column.hh" // urg
-#include "font-interface.hh"
+#include "percent-repeat-item.hh"
 #include "rest.hh"
-#include "misc.hh"
+#include "separation-item.hh"
+#include "spacing-options.hh"
 #include "spanner.hh"
+#include "staff-symbol.hh"
 #include "staff-symbol-referencer.hh"
 #include "system.hh"
 #include "text-interface.hh"
-#include "percent-repeat-item.hh"
-#include "lookup.hh"
-#include "separation-item.hh"
+#include "warn.hh"
 
 Interval
 Multi_measure_rest::bar_width (Spanner *me)
 {
+  SCM spacing_pair = me->get_property ("spacing-pair");
   Interval iv;
-  Direction d = LEFT;
-  do
+  for (LEFT_and_RIGHT (d))
     {
       Item *col = me->get_bound (d)->get_column ();
-
-      Interval coldim = Paper_column::break_align_width (col);
+      SCM align_sym
+        = (scm_is_pair (spacing_pair)
+           ? index_get_cell (spacing_pair, d)
+           : ly_symbol2scm ("staff-bar"));
+      Interval coldim = Paper_column::break_align_width (col, align_sym);
 
       iv[d] = coldim[-d];
     }
-  while ((flip (&d)) != LEFT);
 
   return iv;
 }
@@ -55,15 +62,16 @@ MAKE_SCHEME_CALLBACK (Multi_measure_rest, percent, 1);
 SCM
 Multi_measure_rest::percent (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Spanner *sp = dynamic_cast<Spanner *> (me);
 
   Stencil r = Percent_repeat_item_interface::x_percent (me, 1);
+  r.translate_axis (-r.extent (X_AXIS).center (), X_AXIS);
 
   // ugh copy & paste.
 
   Grob *common_x = sp->get_bound (LEFT)->common_refpoint (sp->get_bound (RIGHT),
-                                                         X_AXIS);
+                                                          X_AXIS);
   Interval sp_iv = bar_width (sp);
   Real x_off = 0.0;
 
@@ -88,7 +96,7 @@ MAKE_SCHEME_CALLBACK (Multi_measure_rest, print, 1);
 SCM
 Multi_measure_rest::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Spanner *sp = dynamic_cast<Spanner *> (me);
 
   Interval sp_iv = bar_width (sp);
@@ -104,27 +112,104 @@ Multi_measure_rest::print (SCM smob)
   Stencil mol;
   mol.add_stencil (symbol_stencil (me, space));
 
-  int measures = 0;
-  SCM m (me->get_property ("measure-count"));
-  if (scm_is_number (m))
-    measures = scm_to_int (m);
-
   mol.translate_axis (x_off, X_AXIS);
   return mol.smobbed_copy ();
 }
 
+MAKE_SCHEME_CALLBACK (Multi_measure_rest, height, 1);
+SCM
+Multi_measure_rest::height (SCM smob)
+{
+  Grob *me = unsmob<Grob> (smob);
+
+  Real space = 1000000; // something very large...
+
+  Stencil mol;
+  mol.add_stencil (symbol_stencil (me, space));
+
+  return ly_interval2scm (mol.extent (Y_AXIS));
+}
+
+int
+calc_closest_duration_log (Grob *me, double duration, bool force_round_up)
+{
+  bool round_up = force_round_up
+                  || to_boolean (me->get_property ("round-up-to-longer-rest"));
+  int closest_usable_duration_log;
+
+  // Out of range initial values.
+  if (round_up)
+    closest_usable_duration_log = -15; // high value
+  else
+    closest_usable_duration_log = 15; // low value
+  int minimum_usable_duration_log = -15;
+  int maximum_usable_duration_log = 15;
+
+  SCM duration_logs_list = me->get_property ("usable-duration-logs");
+  if (to_boolean (scm_null_p (duration_logs_list))
+      || !to_boolean (scm_list_p (duration_logs_list)))
+    {
+      warning (_ ("usable-duration-logs must be a non-empty list."
+                  "  Falling back to whole rests."));
+      closest_usable_duration_log = 0;
+    }
+  else
+    {
+      for (SCM s = duration_logs_list; scm_is_pair (s); s = scm_cdr (s))
+        {
+          int dur_log = scm_to_int (scm_car (s));
+          if (dur_log > minimum_usable_duration_log)
+            minimum_usable_duration_log = dur_log;
+          if (dur_log < maximum_usable_duration_log)
+            maximum_usable_duration_log = dur_log;
+          double dur = pow (2.0, -dur_log);
+          if (round_up)
+            {
+              if (duration <= dur && dur_log > closest_usable_duration_log)
+                closest_usable_duration_log = dur_log;
+            }
+          else
+            {
+              if (duration >= dur && dur_log < closest_usable_duration_log)
+                closest_usable_duration_log = dur_log;
+            }
+        }
+    }
+
+  if (closest_usable_duration_log == 15)
+    closest_usable_duration_log = minimum_usable_duration_log;
+  if (closest_usable_duration_log == -15)
+    closest_usable_duration_log = maximum_usable_duration_log;
+
+  return closest_usable_duration_log;
+}
+
+int
+calc_measure_duration_log (Grob *me)
+{
+  SCM sml = dynamic_cast<Spanner *> (me)->get_bound (LEFT)
+            ->get_property ("measure-length");
+  Rational ml = (unsmob<Moment> (sml)) ? unsmob<Moment> (sml)->main_part_
+                : Rational (1);
+  double measure_duration = ml.Rational::to_double ();
+  bool force_round_up = to_boolean (scm_list_p (scm_member (scm_cons (scm_from_int64 (ml.numerator ()),
+                                                            scm_from_int64 (ml.denominator ())),
+                                                            me->get_property ("round-up-exceptions"))));
+  return calc_closest_duration_log (me, measure_duration, force_round_up);
+}
+
 Stencil
 Multi_measure_rest::symbol_stencil (Grob *me, Real space)
 {
-  int measures = 0;
+  int measure_count = 0;
   SCM m (me->get_property ("measure-count"));
   if (scm_is_number (m))
-    measures = scm_to_int (m);
-  if (measures <= 0)
+    measure_count = scm_to_int (m);
+  if (measure_count <= 0)
     return Stencil ();
 
   SCM limit = me->get_property ("expand-limit");
-  if (measures > scm_to_int (limit))
+  if (measure_count > scm_to_int (limit))
     {
       Real padding = 0.15;
       Stencil s = big_rest (me, (1.0 - 2 * padding) * space);
@@ -132,38 +217,25 @@ Multi_measure_rest::symbol_stencil (Grob *me, Real space)
       return s;
     }
 
-  Real staff_space = Staff_symbol_referencer::staff_space (me);
-
   Font_metric *musfont = Font_interface::get_default_font (me);
+  int mdl = calc_measure_duration_log (me);
 
-  SCM sml = me->get_property ("use-breve-rest");
-  if (measures == 1)
+  if (measure_count == 1)
     {
-      if (to_boolean (sml))
-       {
-         Stencil s = musfont->find_by_name (Rest::glyph_name (me, -1, "", false));
+      if (scm_is_null (me->get_property ("staff-position")))
+        {
+          int dir = get_grob_direction (me);
+          Real pos = Rest::staff_position_internal (me, mdl, dir);
+          me->set_property ("staff-position", scm_from_double (pos));
+        }
 
-         s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
+      Stencil s = musfont->find_by_name (Rest::glyph_name (me, mdl, "", true, 0.0));
 
-         return s;
-       }
-      else
-       {
-         Stencil s = musfont->find_by_name (Rest::glyph_name (me, 0, "", true));
-
-         /*
-           ugh.
-         */
-         if (Staff_symbol_referencer::get_position (me) == 0.0)
-           s.translate_axis (staff_space, Y_AXIS);
-
-         s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
-
-         return s;
-       }
+      s.translate_axis ((space - s.extent (X_AXIS).length ()) / 2, X_AXIS);
+      return s;
     }
   else
-    return church_rest (me, musfont, measures, space);
+    return church_rest (me, musfont, measure_count, space);
 }
 
 /*
@@ -198,82 +270,77 @@ Multi_measure_rest::big_rest (Grob *me, Real width)
   Kirchenpause (?)
 */
 Stencil
-Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measures,
-                                Real space)
+Multi_measure_rest::church_rest (Grob *me, Font_metric *musfont, int measure_count,
+                                 Real space)
 {
   SCM mols = SCM_EOL;
-
-  /* See Wanske pp. 125  */
-  int l = measures;
-  int count = 0;
+  int symbol_count = 0;
   Real symbols_width = 0.0;
+  double total_duration = measure_count * pow (2.0, -calc_measure_duration_log (me));
+
+  SCM staff_position = me->get_property ("staff-position");
 
-  bool use_breve = to_boolean (me->get_property ("use-breve-rest"));
+  if (!scm_is_number (staff_position))
+    {
+      // Staff position is somewhat icky regarding its definition for
+      // compatibility reasons.  It is intended to be the baseline of
+      // a breve rest.  However, when the staff space is more than
+      // single space (like with tablature), it looks better if all
+      // rests are actually hanging.  So staff position, in reality,
+      // is the semi-breve position - 2.  Everything else is
+      // calculated from there.
+      int dir = get_grob_direction (me);
+      Real pos = Rest::staff_position_internal (me, 0, dir);
+      me->set_property ("staff-position", scm_from_double (pos - 2));
+    }
 
-  while (l)
+  while (total_duration > 0)
     {
-      if (use_breve)
-       {
-         int k;
-         if (l >= 2)
-           {
-             l -= 2;
-             k = -2;
-           }
-         else
-           {
-             l -= 1;
-             k = -1;
-           }
-
-         Stencil r (musfont->find_by_name ("rests." + to_string (k)));
-         symbols_width += r.extent (X_AXIS).length ();
-         mols = scm_cons (r.smobbed_copy (), mols);
-       }
+      int dl = calc_closest_duration_log (me, total_duration, false);
+      double duration = pow (2.0, -dl);
+
+      total_duration -= duration;
+
+      Stencil r = musfont->find_by_name (Rest::glyph_name (me, dl, "", true, 2));
+
+      Real staff_space = Staff_symbol_referencer::staff_space (me);
+      if (dl == 0)
+        {
+          r.translate_axis (staff_space, Y_AXIS);
+        }
       else
-       {
-         int k;
-         if (l >= 4)
-           {
-             l -= 4;
-             k = -2;
-           }
-         else if (l >= 2)
-           {
-             l -= 2;
-             k = -1;
-           }
-         else
-           {
-             k = 0;
-             l--;
-           }
-
-         Stencil r (musfont->find_by_name ("rests." + to_string (k)));
-         if (k == 0)
-           {
-             Real staff_space = Staff_symbol_referencer::staff_space (me);
-             r.translate_axis (staff_space, Y_AXIS);
-           }
-         symbols_width += r.extent (X_AXIS).length ();
-         mols = scm_cons (r.smobbed_copy (), mols);
-       }
-      count++;
+        {
+          r.translate_axis (staff_space-r.extent (Y_AXIS).at (UP), Y_AXIS);
+        }
+      symbols_width += r.extent (X_AXIS).length ();
+      mols = scm_cons (r.smobbed_copy (), mols);
+      symbol_count++;
     }
 
-  /* Make outer padding this much bigger.  */
+  /*
+    When symbols spread to fullest extent, outer padding is this much
+    bigger.
+  */
   Real outer_padding_factor = 1.5;
+  /* Widest gap between symbols; to be limited by max-symbol-separation */
   Real inner_padding = (space - symbols_width)
-    / (2 * outer_padding_factor + (count - 1));
+                       / (2 * outer_padding_factor + (symbol_count - 1));
   if (inner_padding < 0)
     inner_padding = 1.0;
 
+  Real max_separation = max (robust_scm2double (me->get_property ("max-symbol-separation"), 8.0),
+                             1.0);
+
+  inner_padding = min (inner_padding, max_separation);
+  Real left_offset = (space - symbols_width - (inner_padding * (symbol_count - 1)))
+                     / 2;
+
   Stencil mol;
   for (SCM s = mols; scm_is_pair (s); s = scm_cdr (s))
-    mol.add_at_edge (X_AXIS, LEFT, *unsmob_stencil (scm_car (s)),
-                    inner_padding);
+    mol.add_at_edge (X_AXIS, LEFT, *unsmob<Stencil> (scm_car (s)),
+                     inner_padding);
   mol.align_to (X_AXIS, LEFT);
-  mol.translate_axis (outer_padding_factor * inner_padding, X_AXIS);
+  mol.translate_axis (left_offset, X_AXIS);
 
   return mol;
 }
@@ -291,7 +358,7 @@ Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
   if (! (sp->get_bound (LEFT) && sp->get_bound (RIGHT)))
     {
       programming_error ("Multi_measure_rest::get_rods (): I am not spanned!");
-      return ;
+      return;
     }
 
   Item *li = sp->get_bound (LEFT)->get_column ();
@@ -299,10 +366,30 @@ Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
   Item *lb = li->find_prebroken_piece (RIGHT);
   Item *rb = ri->find_prebroken_piece (LEFT);
 
+  Grob *spacing = unsmob<Grob> (li->get_object ("spacing"));
+  if (!spacing)
+    spacing = unsmob<Grob> (ri->get_object ("spacing"));
+  if (spacing)
+    {
+      Spacing_options options;
+      options.init_from_grob (me);
+      Moment mlen = robust_scm2moment (li->get_property ("measure-length"),
+                                       Moment (1));
+      length += robust_scm2double (li->get_property ("full-measure-extra-space"), 0.0)
+                + options.get_duration_space (mlen.main_part_)
+                + (robust_scm2double (me->get_property ("space-increment"), 0.0)
+                   * log_2 (robust_scm2int (me->get_property ("measure-count"), 1)));
+    }
+
+  length += 2 * robust_scm2double (me->get_property ("bound-padding"), 0.0);
+
+  Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0.0);
+
   Item *combinations[4][2] = {{li, ri},
-                             {lb, ri},
-                             {li, rb},
-                             {lb, rb}};
+    {lb, ri},
+    {li, rb},
+    {lb, rb}
+  };
 
   for (int i = 0; i < 4; i++)
     {
@@ -310,18 +397,14 @@ Multi_measure_rest::calculate_spacing_rods (Grob *me, Real length)
       Item *ri = combinations[i][1];
 
       if (!li || !ri)
-       continue;
+        continue;
 
       Rod rod;
       rod.item_drul_[LEFT] = li;
       rod.item_drul_[RIGHT] = ri;
 
-      rod.distance_ = Paper_column::minimum_distance (li, ri)
-       + length
-       + 2 * robust_scm2double (me->get_property ("bound-padding"), 1.0);
-
-      Real minlen = robust_scm2double (me->get_property ("minimum-length"), 0);
-      rod.distance_ = max (rod.distance_, minlen);
+      rod.distance_ = max (Paper_column::minimum_distance (li, ri) + length,
+                           minlen);
       rod.add_to_cols ();
     }
 }
@@ -330,39 +413,43 @@ MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_spacing_rods, 1);
 SCM
 Multi_measure_rest::set_spacing_rods (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Real sym_width = symbol_stencil (me, 0.0).extent (X_AXIS).length ();
   calculate_spacing_rods (me, sym_width);
 
-  return SCM_UNSPECIFIED;  
+  return SCM_UNSPECIFIED;
 }
-  
+
 MAKE_SCHEME_CALLBACK (Multi_measure_rest, set_text_rods, 1);
 SCM
 Multi_measure_rest::set_text_rods (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Stencil *stil = me->get_stencil ();
 
   /* FIXME uncached */
   Real len = (stil && !stil->extent (X_AXIS).is_empty ())
-    ? stil->extent (X_AXIS).length ()
-    : 0.0;
+             ? stil->extent (X_AXIS).length ()
+             : 0.0;
   calculate_spacing_rods (me, len);
 
   return SCM_UNSPECIFIED;
 }
 
 ADD_INTERFACE (Multi_measure_rest,
-              "A rest that spans a whole number of measures.",
-
-              /* properties */
-              "expand-limit "
-              "measure-count "
-              "hair-thickness "
-              "thick-thickness "
-              "use-breve-rest "
-              "bound-padding "
-              "minimum-length "
-              );
-
+               "A rest that spans a whole number of measures.",
+
+               /* properties */
+               "bound-padding "
+               "expand-limit "
+               "hair-thickness "
+               "max-symbol-separation "
+               "measure-count "
+               "minimum-length "
+               "round-up-exceptions "
+               "round-up-to-longer-rest "
+               "space-increment "
+               "spacing-pair "
+               "thick-thickness "
+               "usable-duration-logs "
+              );