]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-spanner.cc
''
[lilypond.git] / lily / spacing-spanner.cc
index ffce2a7ac7d7e55084bd0edf4b28540d9fd44192..803265d12a6c9daa17dc9ef955fbf28e287b31d4 100644 (file)
@@ -10,7 +10,8 @@
 #include <math.h>
 #include <stdio.h>
 
-#include "line-of-score.hh"
+#include "system.hh"
+#include "paper-def.hh"
 #include "paper-score.hh"
 #include "paper-column.hh"
 #include "item.hh"
 #include "spring.hh"
 #include "paper-column.hh"
 #include "spaceable-grob.hh"
+#include "break-align-interface.hh"
+
+
+
 
 /*
   paper-column:
-
-  Don't be confused by right-items: each spacing wish can also contain
-  a number of items, with which a spacing constraint may be kept. It's
-  a little baroque, but it might come in handy later on?
-    
  */
-
 class Spacing_spanner
 {
 public:
+  static void standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
+                                                Real * fixed, Real * space, Moment);
+  
+
   static Real default_bar_spacing (Grob*,Grob*,Grob*,Moment);
   static Real note_spacing (Grob*,Grob*,Grob*,Moment, bool*);
   static Real get_duration_space (Grob*,Moment dur, Rational shortest, bool*);
-  static Rational find_shortest (Link_array<Grob> const &);  
-  static void breakable_column_spacing (Item* l, Item *r);
+  static Rational find_shortest (Grob *, Link_array<Grob> const &);  
+  static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment);
   static void find_loose_columns () {}
-  static void prune_loose_colunms (Link_array<Grob> *cols);
+  static void prune_loose_colunms (Grob*,Link_array<Grob> *cols, Rational);
   static void find_loose_columns (Link_array<Grob> cols);
   static void set_explicit_neighbor_columns (Link_array<Grob> cols);
   static void set_implicit_neighbor_columns (Link_array<Grob> cols);
   static void do_measure (Rational, Grob*me,Link_array<Grob> *cols);
+  static void musical_column_spacing (Grob*,Item*,Item*, Real, Rational); 
   DECLARE_SCHEME_CALLBACK (set_springs, (SCM ));
+  static bool has_interface (Grob*);
 };
 
 /*
@@ -77,9 +82,7 @@ loose_column (Grob *l, Grob *c, Grob *r)
 
     the column containing the clef is really loose, and should be
     attached right to the first column, but that is a lot of work for
-    such a borderline case.
-
-    )
+    such a borderline case.)
     
   */  
   if (!gh_pair_p (lns) || !gh_pair_p (rns))
@@ -100,12 +103,34 @@ loose_column (Grob *l, Grob *c, Grob *r)
   if (!l_neighbor || !r_neighbor)
     return false;
 
+
+  /*
+    A rather hairy check, but we really only want to move around clefs. (anything else?)
+
+    in any case, we don't want to move bar lines.
+   */
+  for (SCM e = c->get_grob_property ("elements"); gh_pair_p (e); e = gh_cdr (e))
+    {
+      Grob * g = unsmob_grob (gh_car (e));
+      if (g && Break_align_interface::has_interface (g))
+       {
+         for (SCM s = g->get_grob_property ("elements"); gh_pair_p (s);
+              s = gh_cdr (s))
+           {
+             Grob *h = unsmob_grob (gh_car (s));
+
+             if (h  && h->get_grob_property ("break-align-symbol") == ly_symbol2scm ("bar-line"))
+               return false;
+           }
+       }
+    }
+  
   /*
     Only declare loose if the bounds make a little sense.  This means
     some cases (two isolated, consecutive clef changes) won't be
     nicely folded, but hey, then don't do that.
   */
-  if(Paper_column::musical_b (l_neighbor) || Item::breakable_b (l_neighbor))
+  if ((Paper_column::musical_b (l_neighbor) || Item::breakable_b (l_neighbor))
       && (Paper_column::musical_b (r_neighbor) || Item::breakable_b (r_neighbor)))
     {
       return true;
@@ -128,10 +153,10 @@ loose_column (Grob *l, Grob *c, Grob *r)
   between.
 */
 void
-Spacing_spanner::prune_loose_colunms (Link_array<Grob> *cols)
+Spacing_spanner::prune_loose_colunms (Grob*me,Link_array<Grob> *cols, Rational shortest)
 {
   Link_array<Grob> newcols;
-  
+  Real increment = gh_scm2double (me->get_grob_property ("spacing-increment"));
   for (int i=0; i < cols->size ();  i++)
     {
       if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i)))
@@ -169,8 +194,8 @@ Spacing_spanner::prune_loose_colunms (Link_array<Grob> *cols)
          do
            {
              dists[d] = 0.0;
-             Grob *lc = (d == LEFT)  ? next_door[LEFT] : c;
-             Grob *rc = d == LEFT  ? c : next_door[RIGHT];           
+             Item *lc = dynamic_cast<Item*> ((d == LEFT)  ? next_door[LEFT] : c);
+             Item *rc = dynamic_cast<Item*> (d == LEFT  ? c : next_door[RIGHT]);
 
              for (SCM s = lc->get_grob_property ("spacing-wishes");
                   gh_pair_p (s); s = gh_cdr (s))
@@ -180,7 +205,33 @@ Spacing_spanner::prune_loose_colunms (Link_array<Grob> *cols)
                      || Note_spacing::right_column (sp) != rc)
                    continue;
 
-                 dists[d] = dists[d] >? Note_spacing::get_spacing (sp);
+                 Real space, fixed;
+                 fixed = 0.0;
+                 bool dummy;
+
+                 if (d == LEFT)
+                   {
+                     /*
+                       The note spacing should be taken from the musical
+                       columns.
+                   
+                     */
+                     Real base = note_spacing (me, lc, rc, shortest, &dummy);
+                     Note_spacing::get_spacing (sp, rc, base, increment, &space, &fixed);
+
+                     space -= increment; 
+                 
+                     dists[d] = dists[d] >? space;
+                   }
+                 else
+                   {
+                     Real space, fixed_space;
+                     Staff_spacing::get_spacing_params (sp,
+                                                        &space, &fixed_space);
+
+                     dists[d] = dists[d] >? fixed_space;
+                   }
+                 
                }
            }
          while (flip (&d) != LEFT);
@@ -312,10 +363,11 @@ Spacing_spanner::set_springs (SCM smob)
   Link_array<Grob> all (me->pscore_l_->line_l_->column_l_arr ()) ;
 
   set_explicit_neighbor_columns (all);
-  prune_loose_colunms (&all);
+
+  Rational global_shortest = find_shortest (me, all);
+  prune_loose_colunms (me, &all, global_shortest);
   set_implicit_neighbor_columns (all);
 
-  Rational global_shortest = find_shortest (all);
   
   int j = 0;
   for (int i = 1; i < all.size (); i++)
@@ -344,7 +396,7 @@ Spacing_spanner::set_springs (SCM smob)
 
 */
 Rational
-Spacing_spanner::find_shortest (Link_array<Grob> const &cols)
+Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
 {
   /*
     ascending in duration
@@ -411,19 +463,26 @@ Spacing_spanner::find_shortest (Link_array<Grob> const &cols)
          max_count = counts[i];
        }
 
-      //      printf ("Den %d/%d, c %d\n", durations[i].num (), durations[i].den (), counts[i]);
+      //      printf ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]);
     }
 
-  /*
-    TODO: 1/8 should be adjustable?
-   */
+  SCM  bsd = me->get_grob_property ("base-shortest-duration");
   Rational d = Rational (1,8);
+  if (Moment *m = unsmob_moment (bsd))
+    d = m->main_part_;
+  
   if (max_idx >= 0)
     d = d <? durations[max_idx] ;
 
   return d;
 }
 
+/*
+  Generate spacing for a single measure. We used to have code that did
+  per-measure spacing. Now we have piecewise spacing. We should fix
+  this to support "spacing-regions": some regions have different notes
+  (different time sigs) than others, and should be spaced differently.
+ */
 void
 Spacing_spanner::do_measure (Rational shortest, Grob*me, Link_array<Grob> *cols) 
 {
@@ -439,7 +498,7 @@ Spacing_spanner::do_measure (Rational shortest, Grob*me, Link_array<Grob> *cols)
 
       if (!Paper_column::musical_b (l))
        {
-         breakable_column_spacing (l, r);
+         breakable_column_spacing (me, l, r, shortest);
 
          /*
            
@@ -452,95 +511,142 @@ Spacing_spanner::do_measure (Rational shortest, Grob*me, Link_array<Grob> *cols)
          Item *rb = r->find_prebroken_piece (LEFT);
          
          if (lb)
-           breakable_column_spacing (lb,r);
+           breakable_column_spacing (me, lb,r, shortest);
 
          if (rb)
-           breakable_column_spacing (l, rb);
+           breakable_column_spacing (me, l, rb, shortest);
          if (lb && rb)
-           breakable_column_spacing (lb, rb);
+           breakable_column_spacing (me, lb, rb, shortest);
          
          continue ; 
        }
-      bool expand_only = false;
-      Real note_space = note_spacing (me, lc, rc, shortest, &expand_only);
-      
-      Real hinterfleisch = note_space;
 
 
-      SCM seq  = lc->get_grob_property ("right-neighbors");
+      musical_column_spacing (me, lc, rc, headwid, shortest);
+      if (Item *rb = r->find_prebroken_piece (LEFT))
+       musical_column_spacing (me, lc, rb, headwid, shortest);
+    }    
+}
 
-      /*
-       hinterfleisch = hind-meat = amount of space following a note.
 
-       
-       We adjust the space following a note only if the next note
-       happens after the current note (this is set in the grob
-       property SPACING-SEQUENCE.  */
+/*
+  Generate the space between two musical columns LC and RC, given
+  spacing parameters INCR and SHORTEST.
+ */
+void
+Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real increment, Rational shortest)
+{
+  bool expand_only = false;
+  Real base_note_space = note_spacing (me, lc, rc, shortest, &expand_only);
+
+  Real max_note_space = -infinity_f;
+  Real max_fixed_note_space = -infinity_f;
 
-      Real stretch_distance = note_space;
+  SCM seq  = lc->get_grob_property ("right-neighbors");
 
-      hinterfleisch = -1.0;
-      Real max_factor = 0.0;
-      for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s))
+  /*
+    We adjust the space following a note only if the next note
+    happens after the current note (this is set in the grob
+    property SPACING-SEQUENCE.
+  */
+  for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s))
+    {
+      Grob * wish = unsmob_grob (gh_car (s));
+
+      Item *wish_rcol = Note_spacing::right_column (wish);
+      if (Note_spacing::left_column (wish) != lc
+         || (wish_rcol != rc && wish_rcol != rc->original_l_))
+       continue;
+
+      /*
+       This is probably a waste of time in the case of polyphonic
+       music.  */
+      if (Note_spacing::has_interface (wish))
        {
-         Grob * wish = unsmob_grob (gh_car (s));
+         Real space =0.0;
+         Real fixed =0.0;
+         
+         Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed);
+         max_note_space = max_note_space >? space;
+         max_fixed_note_space = max_fixed_note_space >? fixed;
+       }
+    }
 
-         if (Note_spacing::left_column (wish) != lc
-             || Note_spacing::right_column (wish) != rc)
-           continue;
+  if (max_note_space < 0)
+    {
+      max_note_space = base_note_space;
+      max_fixed_note_space =  increment;
+    }
 
-         /*
-           This is probably a waste of time in the case of polyphonic
-           music.  */
-         if (Note_spacing::has_interface (wish))
-           {
-             hinterfleisch = hinterfleisch >?
-               ( - headwid +
+  bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright"));
 
-                 (note_space + Note_spacing::get_spacing (wish))
-                 *gh_scm2double (wish->get_grob_property ("space-factor"))
+  /*
+    Whatever we do, the fixed space is smaller than the real
+    space.
 
-                 + Note_spacing::stem_dir_correction (wish));
-           }
-       }
+    TODO: this criterion is discontinuous in the derivative.
+    Maybe it should be continuous?
+  */
+  max_fixed_note_space = max_fixed_note_space <?  max_note_space;
+  
+  Real strength = (ragged) ? 1.0 : 1 / (max_note_space - max_fixed_note_space);
+  Real distance = (ragged) ? max_fixed_note_space : max_note_space;
+  //  Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only);
+  
+  Spaceable_grob::add_spring (lc, rc, distance, strength, false);  
+}
 
-      if (hinterfleisch < 0)
-       {
-         // maybe should issue a programming error.
-         hinterfleisch = note_space;
-       }
-      else
-       stretch_distance -= headwid; // why?
 
-      if (max_factor == 0.0)
-       max_factor = 1.0; 
+/*
+  The one-size-fits all spacing. It doesn't take into account
+  different spacing wishes from one to the next column.
+ */
+void
+Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
+                                  Real * fixed, Real * space,
+                                  Moment shortest)
+{
+  *fixed = l->extent (l, X_AXIS)[RIGHT] - r->extent (r, X_AXIS)[LEFT];
       
-      Spaceable_grob::add_spring (l, r, max_factor *  hinterfleisch,  1 / stretch_distance, expand_only);
+  if (l->breakable_b (l) && r->breakable_b(r))
+    {
+      Moment *dt = unsmob_moment (l->get_grob_property ("measure-length"));
+      Moment mlen (1);
+      if (dt)
+       mlen = *dt;
+      
+      Real incr = gh_scm2double (me->get_grob_property ("spacing-increment"));
 
-      /*
-       TODO: we should have a separate routine determining this distance!
-       */
-      if (Item *rb = r->find_prebroken_piece (LEFT))
-       {
-         Spaceable_grob::add_spring (l, rb, max_factor *  hinterfleisch,  1 / stretch_distance, expand_only);
-       }
+      *space =  *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8;
     }
+  else
+    {
+      Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
+      bool dummy;
 
+      *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy);
+    }
+  
+  
 }
 
+
 /*
-  Read hints from L (todo: R) and generate springs.
+  Read hints from L and generate springs.
  */
 void
-Spacing_spanner::breakable_column_spacing (Item* l, Item *r)
+Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest)
 {
   Real max_fixed = -infinity_f;
   Real max_space = -infinity_f;
+
+  standard_breakable_column_spacing (me, l, r, &max_fixed, &max_space ,
+                                    shortest);
   
   for (SCM s = l->get_grob_property ("spacing-wishes");
        gh_pair_p (s); s = gh_cdr (s))
     {
-      Grob * spacing_grob = unsmob_grob (gh_car (s));
+      Item * spacing_grob = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
 
       if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
        continue;
@@ -548,6 +654,13 @@ Spacing_spanner::breakable_column_spacing (Item* l, Item *r)
       Real space;
       Real fixed_space;
 
+      /*
+       column for the left one settings should be ok due automatic
+       pointer munging.
+
+      */
+      assert (spacing_grob-> column_l () == l);
+
       Staff_spacing::get_spacing_params (spacing_grob,
                                         &space, &fixed_space);  
       if (space > max_space)
@@ -557,14 +670,44 @@ Spacing_spanner::breakable_column_spacing (Item* l, Item *r)
        }
     }
 
+  
+  
+    
   if (isinf (max_space))
     {
-      programming_error ("No pref spacing found");
+    /*
+      One situation where this can happen is when there is a column
+      that only serves as a spanning point for a short staff-symbol.
+
+     ===============X===
+
+         |=======Y
+
+
+      (here no StaffSpacing from Y to X is found.)
+    */      
+      programming_error ("No StaffSpacing wishes found");
       max_space = 2.0;
       max_fixed = 1.0;
     }
 
-  Spaceable_grob::add_spring (l, r, max_space,  1/(max_space - max_fixed), false);  
+  
+  if (l->break_status_dir() == RIGHT
+      && Paper_column::when_mom (l) == Paper_column::when_mom (r))
+    {
+      /* Start of line: this space is not stretchable */
+      max_fixed = max_space;
+    }
+
+  /*
+    Hmm.  we do 1/0 in the next thing. Perhaps we should check if this
+    works on all architectures.
+   */
+  
+  bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright"));
+  Real strength = (ragged) ? 1.0 : 1 / (max_space - max_fixed);
+  Real distance = (ragged) ? max_fixed : max_space;
+  Spaceable_grob::add_spring (l, r, distance, strength, false);
 }
 
 
@@ -575,28 +718,44 @@ Real
 Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only) 
 {
   Real k = gh_scm2double (me->get_grob_property ("shortest-duration-space"));
-    
+  Real incr = gh_scm2double (me->get_grob_property ("spacing-increment"));
+  
   if (d < shortest)
     {
+      /*
+       We don't space really short notes using the log of the
+       duration, since it would disproportionally stretches the long
+       notes in a piece. In stead, we use geometric spacing with constant 0.5
+       (i.e. linear.)
+
+       This should probably be tunable, to use other base numbers.
+
+       In Mozart hrn3 by EB., we have 8th note = 3.9 mm (total), 16th note =
+       3.6 mm (total).  head-width = 2.4, so we 1.2mm for 16th, 1.5
+       mm for 8th. (white space), suggesting that we use
+
+       (1.2 / 1.5)^{-log2(duration ratio)}
+       
+
+       */
       Rational ratio = d.main_part_ / shortest;
       
       *expand_only = true;
-      return (0.5 + 0.5 * double (ratio)) * k ;
+      return ((k-1) + double (ratio)) * incr;
     }
   else
     {
       /*
-         @see
-  John S. Gourlay. ``Spacing a Line of Music,'' Technical Report
-  OSU-CISRC-10/87-TR35, Department of Computer and Information Science,
-  The Ohio State University, 1987.
+         John S. Gourlay. ``Spacing a Line of Music,'' Technical
+         Report OSU-CISRC-10/87-TR35, Department of Computer and
+         Information Science, The Ohio State University, 1987.
        */
       Real log =  log_2 (shortest);
       k -= log;
       Rational compdur = d.main_part_ + d.grace_part_ /Rational (3);
       *expand_only = false;      
    
-      return (log_2 (compdur) + k) * gh_scm2double (me->get_grob_property ("spacing-increment"));
+      return (log_2 (compdur) + k) * incr;
     }
 }
 
@@ -615,11 +774,22 @@ Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc,
       programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ());
       shortest_playing_len = 1;
     }
-  
-  Moment delta_t = Paper_column::when_mom (rc) - Paper_column::when_mom (lc);
+
+  Moment lwhen = Paper_column::when_mom (lc);
+  Moment rwhen =  Paper_column::when_mom (rc);
+
+  Moment delta_t = rwhen - lwhen;
   Real dist = 0.0;
 
-  if (delta_t.main_part_)
+  /*
+    In normal situations, the next column is at most
+    SHORTEST_PLAYING_LEN away. However chord-tremolos do funky faking stuff
+    with durations, invalidating this assumption. Here we kludge
+    around to get chord tremolos to behave properly.
+    
+   */
+  shortest_playing_len = shortest_playing_len >? delta_t;
+  if (delta_t.main_part_ && !lwhen.grace_part_)
     {
       dist = get_duration_space (me, shortest_playing_len, shortest.main_part_, expand_only);
       dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_);
@@ -643,3 +813,20 @@ Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc,
   return dist;
 }
 
+
+
+ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface",
+  "
+The space taken by a note is dependent on its duration. Doubling a
+duration adds spacing-increment to the space. The most common shortest
+note gets shortest-duration-space. Notes that are even shorter are
+spaced proportonial to their duration.
+
+Typically, the increment is the width of a black note head.  In a
+piece with lots of 8th notes, and some 16th notes, the eighth note
+gets 2 note heads width (i.e. the space following a note is 1 note
+head width) A 16th note is followed by 0.5 note head width. The
+quarter note is followed by  3 NHW, the half by 4 NHW, etc.
+",
+  "grace-space-factor spacing-increment base-shortest-duration shortest-duration-space");
+