]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/gourlay-breaking.cc
*** empty log message ***
[lilypond.git] / lily / gourlay-breaking.cc
index c05731f1490ff968492f7e23057f2343cff0da96..93192d1a289ad5fc0927f108de501fac7e257e99 100644 (file)
@@ -3,18 +3,20 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 #include <math.h>              // rint
+#include <stdio.h>
 
 #include "gourlay-breaking.hh"
 #include "column-x-positions.hh"
-#include "debug.hh"
+#include "warn.hh"
+#include "main.hh"
 #include "paper-column.hh"
 #include "paper-score.hh"
 #include "paper-def.hh"
 #include "simple-spacer.hh"
-#include "line-of-score.hh"
+#include "system.hh"
 
 /// How often to print operator pacification marks?
 const int HAPPY_DOTS_I = 3;
@@ -27,46 +29,61 @@ struct Break_node {
     considered: this path has infinite energy
     
     */
-  int prev_break_i_;
+  int prev_break_;
   /**
      Which system number so far?
    */
-  int line_i_;
+  int line_;
 
-  Real demerits_f_;
+  Real demerits_;
   Column_x_positions line_config_;
   
   Break_node () 
   {
-    prev_break_i_ = -1;
-    line_i_ = 0;
-    demerits_f_ = 0;
+    prev_break_ = -1;
+    line_ = 0;
+    demerits_ = 0;
+  }
+
+  void print () const
+  {
+    printf ("prev break %d, line %d, demerits %f\n",
+           prev_break_, line_, demerits_);
   }
 };
 
+void
+print_break_nodes (Array<Break_node> const & arr)
+{
+  for (int i =0; i < arr.size (); i++)
+    {
+      printf ( "node %d: ", i); 
+      arr[i].print ();
+    }      
+}
+
 /**
   This algorithms is adapted from the OSU Tech report on breaking lines.
 
   this function is longish, but not very complicated.
-  
  */
 Array<Column_x_positions>
 Gourlay_breaking::do_solve () const
 {
   Array<Break_node> optimal_paths;
   Link_array<Grob> all =
-    pscore_l_->line_l_->column_l_arr ();
+    pscore_->system_->columns ();
   
   Array<int> breaks = find_break_indices ();
   
-  optimal_paths.set_size (breaks.size ());
-
   Break_node first_node ;
-  
-  optimal_paths[0] = first_node; 
-  int break_idx=1;
+  optimal_paths.push (first_node);
 
-  for (; break_idx< breaks.size (); break_idx++) 
+  bool ragged_right = to_boolean (pscore_->paper_->get_scmvar ("raggedright"));
+  bool ragged_last = to_boolean (pscore_->paper_->get_scmvar ("raggedlast"));
+
+  Real worst_force = 0.0;
+  for (int break_idx = 1; break_idx< breaks.size (); break_idx++) 
     {
       /*
        start with a short line, add measures. At some point 
@@ -82,30 +99,42 @@ Gourlay_breaking::do_solve () const
        {
          Link_array<Grob> line = all.slice (breaks[start_idx], breaks[break_idx]+1);
   
-         line[0]     = dynamic_cast<Item*> (line[0])    ->find_prebroken_piece (RIGHT);
+         line[0]     = dynamic_cast<Item*> (line[0])->find_prebroken_piece (RIGHT);
          line.top () = dynamic_cast<Item*> (line.top ())->find_prebroken_piece (LEFT);
            
          Column_x_positions cp;
          cp.cols_ = line;
 
          Interval line_dims
-           = pscore_l_->paper_l_->line_dimensions_int (optimal_paths[start_idx].line_i_);
+           = pscore_->paper_->line_dimensions_int (optimal_paths[start_idx].line_);
          Simple_spacer * sp = generate_spacing_problem (line, line_dims);
-         sp->solve (&cp);
+         bool last_line = break_idx == breaks.size ()-1;
+         bool ragged = ragged_right
+           || (last_line && ragged_last);
+         
+         sp->solve (&cp, ragged);
+         
          delete sp;
 
-         if (start_idx == break_idx - 1)
-           backup_sol = cp;    // in case everything fucks up
-         if (!cp.satisfies_constraints_b_)
-           break;
-
+         if (ragged && last_line)
+           cp.force_ = 0.0;
          
+         if (fabs (cp.force_) > worst_force)
+           worst_force = fabs (cp.force_);
+
+         /*
+           We remember this solution as a "should always work
+           solution", in case everything fucks up.  */
+         if (start_idx == break_idx - 1)
+           backup_sol = cp;
+                 
          Real this_demerits;
-         if (optimal_paths[start_idx].demerits_f_ >= infinity_f)
+
+         if (optimal_paths[start_idx].demerits_ >= infinity_f)
            this_demerits = infinity_f;
          else
            this_demerits = combine_demerits (optimal_paths[start_idx].line_config_, cp)
-             + optimal_paths[start_idx].demerits_f_;
+             + optimal_paths[start_idx].demerits_;
 
          if (this_demerits < minimal_demerits) 
            {
@@ -113,31 +142,39 @@ Gourlay_breaking::do_solve () const
              minimal_sol = cp;
              minimal_demerits = this_demerits;
            }
+
+         /*
+           we couldn't satisfy the constraints, this won't get better
+           if we add more columns, so we get on with the next one
+         */
+         if (!cp.satisfies_constraints_)
+           break ; 
        }
 
-      int prev =break_idx - 1;
+
+      Break_node bnod;
       if (minimal_start_idx < 0) 
        {
-         optimal_paths[break_idx].demerits_f_ = infinity_f;
-         optimal_paths[break_idx].line_config_ = backup_sol;     
+         bnod.demerits_ = infinity_f;
+         bnod.line_config_ = backup_sol;
+         bnod.prev_break_ = break_idx - 1;       
        }
       else 
        {
-         prev = minimal_start_idx;
-         optimal_paths[break_idx].line_config_ = minimal_sol;
-         optimal_paths[break_idx].demerits_f_ = minimal_demerits;
+         bnod.prev_break_ = minimal_start_idx;
+         bnod.demerits_ = minimal_demerits;
+         bnod.line_config_ = minimal_sol;
        }
-      optimal_paths[break_idx].prev_break_i_ = prev;
-      optimal_paths[break_idx].line_i_ = optimal_paths[prev].line_i_ + 1;
-
+      bnod.line_ = optimal_paths[bnod.prev_break_].line_ + 1;
+      optimal_paths.push (bnod);
+      
       if (! (break_idx % HAPPY_DOTS_I))
-       progress_indication (String ("[") + to_str (break_idx) + "]");
+       progress_indication (String ("[") + to_string (break_idx) + "]");
     }
 
   /* do the last one */
-  if  (break_idx % HAPPY_DOTS_I)
-    progress_indication (String ("[") + to_str (break_idx) + "]");    
-
+  if (breaks.size () % HAPPY_DOTS_I)
+    progress_indication (String ("[") + to_string (breaks.size ()) + "]");    
 
   progress_indication ("\n");
 
@@ -148,17 +185,28 @@ Gourlay_breaking::do_solve () const
   for (int i = optimal_paths.size ()-1; i> 0;) 
     {
       final_breaks.push (i);
-      int prev = optimal_paths[i].prev_break_i_;
+      int prev = optimal_paths[i].prev_break_;
       assert (i > prev);
       i = prev;
     }
 
-  if (optimal_paths.top ().demerits_f_ >= infinity_f)
-    warning (_ ("No feasible line breaking found"));
+  if (verbose_global_b)
+    {
+      progress_indication (_f ("Optimal demerits: %f",
+                              optimal_paths.top ().demerits_) + "\n");
+    }
   
-  for (int i= final_breaks.size (); i--;) 
-    lines.push (optimal_paths[final_breaks[i]].line_config_);
+  if (optimal_paths.top ().demerits_ >= infinity_f)
+    warning (_ ("No feasible line breaking found"));
   
+  for (int i= final_breaks.size (); i--;)
+    {
+      Column_x_positions cp (optimal_paths[final_breaks[i]].line_config_);
+      
+      lines.push (cp);
+      if (!cp.satisfies_constraints_)
+       warning ("Could not find line breaking that satisfies constraints.");
+    }
   return lines;
 }
 
@@ -171,6 +219,10 @@ Gourlay_breaking::Gourlay_breaking ()
 
 /*
   TODO: uniformity parameter to control rel. importance of spacing differences.
+
+  TODO:
+
+  mixing break penalties and constraint-failing solutions is confusing.
  */
 Real
 Gourlay_breaking::combine_demerits (Column_x_positions const &prev,
@@ -178,16 +230,43 @@ Gourlay_breaking::combine_demerits (Column_x_positions const &prev,
 {
   Real break_penalties = 0.0;
   Grob * pc = this_one.cols_.top ();
-  if (pc->original_l_)
+  if (pc->original_)
     {
-      SCM pen = pc->get_grob_property ("penalty");
-      if (gh_number_p (pen))
+      SCM pen = pc->get_property ("penalty");
+      if (gh_number_p (pen) && fabs (gh_scm2double (pen)) < 10000)
        {
          break_penalties += gh_scm2double (pen);
        }
     }
 
-  return abs (this_one.force_f_) + abs (prev.force_f_ - this_one.force_f_)
+  /*
+    Q: do we want globally non-cramped lines, or locally equally
+    cramped lines?
+
+    There used to be an example file input/test/uniform-breaking to
+    demonstrate problems with this approach. When music is gradually
+    becoming denser, the uniformity requirement makes lines go from
+    cramped to even more cramped (because going from cramped
+    3meas/line to relatively loose 2meas/line is such a big step.
+    
+   */
+
+  Real demerit = abs (this_one.force_) +  abs (prev.force_ - this_one.force_)
     + break_penalties;
+  
+  if (!this_one.satisfies_constraints_)
+     {
+       /*
+        If it doesn't satisfy constraints, we make this one
+        really unattractive.
+
+        add 20000 to the demerits, so that a break penalty
+        of -10000 won't change the result */
+       demerit = (demerit + 20000) >? 2000;
+       
+       demerit *= 10;
+     }
+
+   return demerit;
 }